HTTP endpoints
HTTP: sessions
All 5 sessions 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/sessions
List sessions or register an agent identity, depending on HTTP method.
Query field names (types and requiredness not specified here): include_inactive.
POST /v1/sessions
List sessions or register an agent identity, depending on HTTP method.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply. Requires an authenticated operator credential or session; an agent_id alone is insufficient.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
agent_id | string | yes | See operation notes. |
display_name | string | no | See operation notes. |
capabilities | array | no | See operation notes. |
metadata | object | no | See operation notes. |
replace | boolean | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/sessions/resume
Resume a joined MCP identity using its prior session and bound resume key.
Access: Available only to loopback callers.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
prior_session_id | string | yes | See operation notes. |
resume_key | string | yes | See operation notes. |
Other constraints may apply, including for fields marked optional.
DELETE /v1/sessions/{id}
Delete session.
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.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/sessions/{id}/rename
Rename session.
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.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
display_name | string | yes | See operation notes. |
Other constraints may apply, including for fields marked optional.