curl --request POST \
--url https://api.boostgpt.co/v1/bot/heartbeat/configure \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"prompt": "<string>",
"cron_pattern": "<string>",
"enabled": false,
"timezone": "UTC",
"credit_budget": 123,
"max_consecutive_errors": 5,
"member_id": "<string>"
}
'{
"heartbeat": {
"uuid": "<string>",
"bot_id": 123,
"member_id": 123,
"prompt": "<string>",
"cron_pattern": "<string>",
"enabled": 0,
"timezone": "<string>",
"credit_budget": 123,
"credits_used": 123,
"last_executed_at": "<string>",
"last_status": "success",
"execution_count": 123,
"error_count": 123,
"max_consecutive_errors": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}Create or update a heartbeat configuration for an agent
curl --request POST \
--url https://api.boostgpt.co/v1/bot/heartbeat/configure \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"prompt": "<string>",
"cron_pattern": "<string>",
"enabled": false,
"timezone": "UTC",
"credit_budget": 123,
"max_consecutive_errors": 5,
"member_id": "<string>"
}
'{
"heartbeat": {
"uuid": "<string>",
"bot_id": 123,
"member_id": 123,
"prompt": "<string>",
"cron_pattern": "<string>",
"enabled": 0,
"timezone": "<string>",
"credit_budget": 123,
"credits_used": 123,
"last_executed_at": "<string>",
"last_status": "success",
"execution_count": 123,
"error_count": 123,
"max_consecutive_errors": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}Enter your API key
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
Heartbeat configured successfully
Show child attributes
Was this page helpful?