HTTP endpoints
HTTP: wakes
All 5 wakes endpoints, with request fields and access notes.
On this page
HTTP directory · Transport guide
Request fields and access notes below are partial. Additional constraints and permissions may apply. Prefer the corresponding MCP tool and schema where available.
GET /v1/wakes
List wakes.
Query field names (types and requiredness not specified here): active_only, agent_id.
POST /v1/wakes
Register wake.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
agent_id | string | yes | See operation notes. |
type | string | yes | See operation notes. |
room_id | string | no | See operation notes. |
channel | string | no | See operation notes. |
params | object | no | See operation notes. |
one_shot | boolean | no | See operation notes. |
delivery | string | no | See operation notes. |
membership_id | string | no | See operation notes. |
target_agent_id | string | no | See operation notes. |
run_id | string | no | See operation notes. |
max_steps | integer | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/wakes/drain
Drain wakes.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Additional body field names (types and requiredness not specified here): agent_id, limit.
Query field names (types and requiredness not specified here): agent_id, limit.
GET /v1/wakes/pending
Read pending wakes.
Query field names (types and requiredness not specified here): agent_id, channel, room_id.
DELETE /v1/wakes/{id}
Cancel wake.
Path parameters: id.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Query field names (types and requiredness not specified here): agent_id.