Reference
Revision requests
The revision requests endpoints of the HTTP API.
GET /dashboards/{id}/revisions
List the agent requests of a dashboard, newest first, including the new-dashboard request that created it.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) |
path | string (uuid) |
|
limit |
query | integer |
Between 1 and 200. Default 50. |
cursor |
query | string |
Responses
| Status | Description | Body |
|---|---|---|
200 |
One page of revisions. | object |
400 |
The request is malformed or fails validation. | Error |
401 |
Authentication is missing or invalid. | Error |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
404 |
The resource does not exist. | Error |
500 |
The server failed to handle the request. | Error |
POST /dashboards/{id}/revisions
Ask the agent to revise a dashboard with a follow-up prompt.
The request is queued and answers 202 at once; the agent saves the result as a new version of the dashboard. Watch the dashboard’s event stream for revision.updated and version.created (the version arrives first, then revision.updated with status succeeded; do not depend on their order), or poll the revision. The agent revises the latest version of the dashboard; base_version is the version the caller was looking at and only gives the agent context. The prompt is trimmed first, and the limit of 1 to 4000 characters applies to the trimmed text. Control characters other than newline, carriage return and tab, and the bidirectional override and isolate characters (U+202A to U+202E and U+2066 to U+2069), are refused. At most 5 revisions may be queued or running per dashboard. Without a configured LLM provider the endpoint answers 503 agent_unavailable. With panel_id the agent focuses on that panel. With comment_id the request is about a comment thread; on success the thread is resolved with the saved version.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) |
path | string (uuid) |
Request body
application/json, required.
| Field | Type | Description |
|---|---|---|
prompt (required) |
string |
|
base_version (required) |
integer |
A version that exists on the dashboard. Between 1 and 2147483647. |
panel_id |
string or null |
The panel the prompt is about; it must exist in the latest version. Omit it or send null for the whole dashboard. |
comment_id |
string (uuid) or null |
A comment or reply whose thread the agent should address; the request takes the thread’s panel, so do not send panel_id with it. When the request succeeds, the server resolves the thread with resolved_by_version set to the saved version, unless it is already resolved. |
Responses
| Status | Description | Body |
|---|---|---|
202 |
The queued revision. | RevisionEnvelope |
400 |
The request is malformed or fails validation. | Error |
401 |
Authentication is missing or invalid. | Error |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
404 |
The dashboard or the version does not exist, or comment_id names no comment on this dashboard. |
Error |
413 |
The request body exceeds the size limit. | Error |
422 |
The panel does not exist in the latest version (unknown_panel). |
Error |
429 |
The dashboard already has 5 revisions queued or running (too_many_revisions). |
Error |
500 |
The server failed to handle the request. | Error |
503 |
No LLM provider is configured (agent_unavailable). |
Error |
GET /dashboards/{id}/revisions/{revision_id}
Read one revision request.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) |
path | string (uuid) |
|
revision_id (required) |
path | string (uuid) |
Responses
| Status | Description | Body |
|---|---|---|
200 |
The revision with its current status. | RevisionEnvelope |
400 |
The request is malformed or fails validation. | Error |
401 |
Authentication is missing or invalid. | Error |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
404 |
The resource does not exist. | Error |
500 |
The server failed to handle the request. | Error |
Generated from api/openapi.yaml at bac0fe39. Report a problem.