Skip to main content
POST
/
v1
/
bot
/
heartbeat
/
configure
Configure Heartbeat
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>",
  "interval_minutes": 30,
  "enabled": false,
  "active_hours_start": "<string>",
  "active_hours_end": "<string>",
  "active_days": "<string>",
  "timezone": "UTC",
  "credit_budget": 123,
  "max_consecutive_errors": 5,
  "member_id": "<string>"
}
'
{
  "heartbeat": {
    "uuid": "<string>",
    "bot_id": 123,
    "member_id": 123,
    "prompt": "<string>",
    "interval_minutes": 123,
    "enabled": 0,
    "active_hours_start": "<string>",
    "active_hours_end": "<string>",
    "active_days": "<string>",
    "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>"
  }
}

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

interval_minutes
integer
default:30

Run interval in minutes (default: 30)

enabled
boolean
default:false

Whether the heartbeat is active (default: false)

active_hours_start
string

Active window start in HH:MM format

active_hours_end
string

Active window end in HH:MM format

active_days
string

Comma-separated days 1-7 (1=Monday)

timezone
string
default:UTC

Timezone for active hours (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