HTTP endpoints
HTTP: assistant
All 12 assistant endpoints, with request fields and access notes.
On this page
- GET /v1/assistant
- POST /v1/assistant/ask
- GET /v1/assistant/model
- POST /v1/assistant/model/cancel
- POST /v1/assistant/model/download
- POST /v1/assistant/model/folder
- POST /v1/assistant/model/remove
- GET /v1/assistant/runs/{id}
- POST /v1/assistant/runs/{id}/cancel
- POST /v1/assistant/runs/{id}/confirm
- PATCH /v1/assistant/settings
- GET /v1/assistant/threads/{id}
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/assistant
Read assistant status.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/assistant/ask
Assistant ask.
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 |
|---|---|---|---|
text | string | yes | See operation notes. |
thread_id | string | no | See operation notes. |
screen | object | no | See operation notes. |
locale | string | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
GET /v1/assistant/model
Read assistant model.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/assistant/model/cancel
Assistant model cancel.
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/assistant/model/download
Assistant model download.
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 |
|---|---|---|---|
executable_path | string | yes | See operation notes. |
pack_id | string | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/assistant/model/folder
Assistant model folder.
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 |
|---|---|---|---|
path | string | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/assistant/model/remove
Assistant model remove.
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 |
|---|---|---|---|
pack_id | string | yes | See operation notes. |
Other constraints may apply, including for fields marked optional.
GET /v1/assistant/runs/{id}
Read assistant run.
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/assistant/runs/{id}/cancel
Assistant run 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.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/assistant/runs/{id}/confirm
Assistant run confirm.
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 |
|---|---|---|---|
step | integer | yes | See operation notes. |
accept | boolean | yes | See operation notes. |
Other constraints may apply, including for fields marked optional.
PATCH /v1/assistant/settings
Assistant 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.
GET /v1/assistant/threads/{id}
Read assistant thread.
Path parameters: id.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.