HTTP endpoints
HTTP: invites
All 5 invites 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/invites
List invites.
Query field names (types and requiredness not specified here): include_revoked, project_id, room_id.
POST /v1/invites
Create invite.
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 |
|---|---|---|---|
room_id | string | yes | See operation notes. |
project_id | string | no | See operation notes. |
role | string | no | See operation notes. |
agent_handle | string | no | See operation notes. |
preferred_harness | string | no | See operation notes. |
single_use | boolean | no | See operation notes. |
max_uses | integer | no | See operation notes. |
ttl_sec | integer | no | See operation notes. |
metadata | object | no | See operation notes. |
naming | object | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
GET /v1/invites/{code}
Get invite.
Path parameters: code.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/invites/{code}/accept
Accept invite.
Path parameters: code.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
agent_id | string | no | See operation notes. |
agent_handle | string | no | See operation notes. |
display_name | string | no | See operation notes. |
capabilities | array | no | See operation notes. |
metadata | object | no | See operation notes. |
preferred_harness | string | no | See operation notes. |
locale | string | no | See operation notes. |
mcp_resume_key | string | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
Query field names (types and requiredness not specified here): locale.
POST /v1/invites/{code}/revoke
Revoke invite.
Path parameters: code.
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.