/v1/workspace/heartbeatRead workspace heartbeat
What the workspace's autonomous heartbeat is allowed to do: whether it is on, its model and reasoning effort, which events wake it, which action kinds it may plan, which of those run on acceptance, its minimum wake interval and per-run action ceiling, the follow-up rules and the queue's lifecycle bounds. A workspace that has never opened the tab reads the defaults, which are OFF, rather than a 404. ANY SEAT — what a machine does inside a workspace is not a secret from the people it does it to.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": {
"allow_system_events": true,
"allowed_actions": [
"string"
],
"auto_execute_on_accept_actions": [
"string"
],
"enabled": true,
"follow_up": {
"after_hours": 1.5,
"auto_send": true,
"enabled": true,
"max_follow_ups": 1.5
},
"lifecycle": {
"default_defer_days": 1.5,
"max_defer_days": 1.5,
"revert_window_minutes": 1.5
},
"max_actions_per_run": 1.5,
"min_wake_interval_seconds": 1.5,
"model": "string",
"preprocess_merchant_inbound_attachments": true,
"reasoning_effort": "string",
"wake_events": [
"string"
]
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}