Skip to main content
POST
CreateHeartbeatAPI mirrors the erdo_create_heartbeat MCP tool.

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Body

application/json
active_days
integer<int64>[]
active_window_end
string
active_window_start
string
dataset_ids
string[]
description
string
effort
string
instructions
string

required: instructions makes an agent automation (an LLM runs each tick); script_js makes a scripted automation (a deterministic zero-LLM JS body runs each tick — strongly preferred for mechanical work like checking a threshold or emailing on new rows, since it costs nothing to run).

interval_minutes
integer<int64>
name
string
script_js
string
timezone
string

Response

Success response

active_days
integer<int64>[]
active_window_end
string
active_window_start
string
created_at
string
description
string
id
string<uuid>
instructions
string
interval_minutes
integer<int64>
kind
string

"script" (a deterministic zero-LLM JS body runs each tick). It tells a caller which body field a read carries and which one an update should send: instructions for an agent automation, script_js for a scripted one.

latest_status
string
name
string
next_run_at
string
script_js
string

Present on a read so a caller can read-modify-write the script.

state
string
timezone
string