Configure Heartbeat
Heartbeat
Configure Heartbeat
Create or update a heartbeat configuration for an agent
POST
Configure Heartbeat
Documentation Index
Fetch the complete documentation index at: https://docs.boostgpt.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Enter your API key
Body
application/json
Project ID
Agent ID
Instruction the agent executes each run
Cron expression for scheduling (e.g., '0 9 * * 1' for every Monday at 9am)
Whether the heartbeat is active (default: false)
Timezone for scheduling (default: UTC)
Max credits per billing period (null = unlimited)
Auto-pause after this many consecutive failures (default: 5)
Subscriber member ID for subscriber-specific heartbeats
Response
Heartbeat configured successfully