HTTP endpoints
HTTP: local-agent
All 31 local-agent endpoints, with request fields and access notes.
On this page
- POST /v1/local-agent/credentials/status
- DELETE /v1/local-agent/credentials/{target}
- POST /v1/local-agent/credentials/{target}
- POST /v1/local-agent/ingress-authorizations
- POST /v1/local-agent/messages/{message_id}/workspace-file
- POST /v1/local-agent/models
- POST /v1/local-agent/peer-note
- POST /v1/local-agent/probe
- GET /v1/local-agent/providers
- GET /v1/local-agent/sessions
- POST /v1/local-agent/sessions
- GET /v1/local-agent/sessions/resumable
- DELETE /v1/local-agent/sessions/{id}
- GET /v1/local-agent/sessions/{id}
- POST /v1/local-agent/sessions/{id}/approvals/{approval_id}
- POST /v1/local-agent/sessions/{id}/cancel
- GET /v1/local-agent/sessions/{id}/context
- GET /v1/local-agent/sessions/{id}/history
- GET /v1/local-agent/sessions/{id}/history/{change_id}
- POST /v1/local-agent/sessions/{id}/history/{turn_id}/exclude
- POST /v1/local-agent/sessions/{id}/history/{turn_id}/reply
- GET /v1/local-agent/sessions/{id}/journal
- POST /v1/local-agent/sessions/{id}/note
- DELETE /v1/local-agent/sessions/{id}/queued-turns/{queue_id}
- POST /v1/local-agent/sessions/{id}/retry
- POST /v1/local-agent/sessions/{id}/rewind
- POST /v1/local-agent/sessions/{id}/shell-artifacts
- POST /v1/local-agent/sessions/{id}/turns
- POST /v1/local-agent/sessions/{id}/undo
- GET /v1/local-agent/settings
- PATCH /v1/local-agent/settings
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.
POST /v1/local-agent/credentials/status
Local agent credential status.
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.
DELETE /v1/local-agent/credentials/{target}
Local agent delete credential.
Path parameters: target.
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/local-agent/credentials/{target}
Local agent store credential.
Path parameters: target.
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): value.
POST /v1/local-agent/ingress-authorizations
Manage desktop ingress authorizations using desktop-specific credentials.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply. Reserved for the Arc desktop integration; requires its client and authorization headers. Ordinary agent sessions cannot use this endpoint.
Additional body field names (types and requiredness not specified here): action.
POST /v1/local-agent/messages/{message_id}/workspace-file
Local agent message file.
Path parameters: message_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/local-agent/models
Local agent models.
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/local-agent/peer-note
Local agent peer note.
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): note, to_agent.
POST /v1/local-agent/probe
Local agent probe.
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.
GET /v1/local-agent/providers
Read local agent providers.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
GET /v1/local-agent/sessions
Read local agent sessions.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions
Local agent start.
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): generation_id.
GET /v1/local-agent/sessions/resumable
Read local agent resumable.
Query field names (types and requiredness not specified here): room_id.
DELETE /v1/local-agent/sessions/{id}
Local agent stop.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
GET /v1/local-agent/sessions/{id}
Read local agent session.
Path parameters: id.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/approvals/{approval_id}
Local agent approval.
Path parameters: id, approval_id.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/cancel
Local agent cancel.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
GET /v1/local-agent/sessions/{id}/context
Read local agent context.
Path parameters: id.
Query field names (types and requiredness not specified here): max_chars.
GET /v1/local-agent/sessions/{id}/history
Read local agent history.
Path parameters: id.
Query field names (types and requiredness not specified here): limit.
GET /v1/local-agent/sessions/{id}/history/{change_id}
Read local agent history preview.
Path parameters: id, change_id.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/history/{turn_id}/exclude
Local agent history exclude.
Path parameters: id, turn_id.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/history/{turn_id}/reply
Local agent history reply.
Path parameters: id, turn_id.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
GET /v1/local-agent/sessions/{id}/journal
Read local agent journal.
Path parameters: id.
Query field names (types and requiredness not specified here): kinds, limit, turn_id.
POST /v1/local-agent/sessions/{id}/note
Local agent note.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
DELETE /v1/local-agent/sessions/{id}/queued-turns/{queue_id}
Local agent queued turn.
Path parameters: id, queue_id.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/retry
Local agent retry.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/rewind
Local agent rewind.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/shell-artifacts
Local agent shell artifact.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/turns
Local agent turn.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/local-agent/sessions/{id}/undo
Local agent undo.
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. Managed-seat operations require authority for the targeted seat.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
GET /v1/local-agent/settings
Read local agent settings.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
PATCH /v1/local-agent/settings
Local agent update settings.
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.