Skip to main content
POST
Configure Heartbeat

Authorizations

Authorization
string
header
required

Enter your API key

Body

application/json
project_id
string
required

Project ID

bot_id
string
required

Agent ID

prompt
string
required

Instruction the agent executes each run

cron_pattern
string

Cron expression for scheduling (e.g., '0 9 * * 1' for every Monday at 9am)

enabled
boolean
default:false

Whether the heartbeat is active (default: false)

timezone
string
default:UTC

Timezone for scheduling (default: UTC)

credit_budget
integer | null

Max credits per billing period (null = unlimited)

max_consecutive_errors
integer
default:5

Auto-pause after this many consecutive failures (default: 5)

member_id
string | null

Subscriber member ID for subscriber-specific heartbeats

Response

Heartbeat configured successfully

heartbeat
object