HTTP endpoints
HTTP: claims
All 4 claims endpoints, with request fields and access notes.
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/claims
List claims.
Query field names (types and requiredness not specified here): active_only, owner_agent_id, thread_id.
POST /v1/claims
Acquire claim.
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 |
|---|---|---|---|
owner_agent_id | string | yes | See operation notes. |
claim_key | string | no | See operation notes. |
task_message_id | integer | no | See operation notes. |
thread_id | string | no | See operation notes. |
ttl_sec | integer | no | At least 5 seconds. |
metadata | object | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/claims/refresh
Refresh claim.
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 |
|---|---|---|---|
claim_key | string | yes | See operation notes. |
owner_agent_id | string | yes | See operation notes. |
ttl_sec | integer | no | At least 5 seconds. |
Other constraints may apply, including for fields marked optional.
POST /v1/claims/release
Release claim.
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 |
|---|---|---|---|
claim_key | string | yes | See operation notes. |
agent_id | string | yes | See operation notes. |
Other constraints may apply, including for fields marked optional.