Deployments.ai Docs
Automations

Create a heartbeat

POST /v1/heartbeats · SDK createHeartbeat · CLI deployments heartbeat create

POST
/v1/heartbeats

Requires schedules:write.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string

Must contain 1–256 UTF-8 bytes with no surrounding whitespace or control characters (U+0000–U+001F and U+007F); maxLength is only a character-count approximation.

Match^(?!\s)(?!.*\s$)[^\u0000-\u001F\u007F]+$
Length1 <= length <= 256

Request Body

application/json
  1. body
activeWindow?
agentDeploymentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
instructions*string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 32000
intervalMs?integer
Range60000 <= value <= 2592000000
skipWhenBusy?boolean
threadId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
timezone?string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 50
workspaceId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Response Body

HeartbeatResponse

application/json
  1. response
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
version*number|||
environmentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
projectId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
workspaceId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
activeWindow?
agentDeploymentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
createdBy?
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
lastRunAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
nextRunAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
object*"heartbeat"
Value in"heartbeat"
schedule*
status*string
Value in"active""archived""disabled""paused""provisioning"
threadId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
curl -X POST "https://example.com/v1/heartbeats" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "agentDeploymentId": "string",    "instructions": "string"  }'
{  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "environmentId": "string",  "organizationId": "string",  "projectId": "string",  "workspaceId": "string",  "activeWindow": {    "daysOfWeek": [      0    ],    "endMinuteOfDay": 0,    "startMinuteOfDay": 1439  },  "agentDeploymentId": "string",  "createdBy": {    "id": "string",    "type": "agent"  },  "id": "string",  "lastRunAt": "2019-08-24T14:15:22Z",  "nextRunAt": "2019-08-24T14:15:22Z",  "object": "heartbeat",  "schedule": {    "instructions": "string",    "intervalMs": 60000,    "skipWhenBusy": true,    "timezone": "string"  },  "status": "active",  "threadId": "string"}