Assistant & prompts — API reference

The in-app chat assistant — questions plus approval-gated writes — and the versioned prompt registry.

Generated from the live OpenAPI schema (version 0.16.6). Download the full spec at /docs/openapi.json.

chat

`GET /chat/settings`

Get Chat Settings

Details

Responses

Status	Description
`200`	Successful Response

`PUT /chat/settings`

Put Chat Settings

Details

Request body (application/json) — required

Field	Type	Required	Description
`connectionId`	string \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`POST /chat/stream`

Chat Stream

Details

Request body (application/json) — required

Field	Type	Required	Description
`messages`	ChatMessage[]	yes
`approved_tool_call`	ApprovedToolCall \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

prompts

`GET /prompts`

List Prompts

Details

Parameters

Parameter	In	Type	Required	Description
`q`	query	string \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`POST /prompts`

Create Prompt

Details

Request body (application/json) — required

Field	Type	Required
`name`	string	yes
`description`	string \| null	no
`promptType`	string	no
`content`	object	yes
`config`	object \| null	no
`commitMessage`	string \| null	no
`sourceType`	string \| null	no
`sourceRef`	string \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`GET /prompts/by-name/{name}`

Resolve By Name

SDK/judge-facing resolution: the content of a prompt by NAME at a label/version/newest.

Details

Parameters

Parameter	In	Type	Required
`name`	path	string	yes
`label`	query	string \| null	no
`version`	query	integer \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`POST /prompts/from-remediation`

From Remediation

Lift a prompt_change remediation’s fixed system prompt into a registry version.

Details

Request body (application/json) — required

Field	Type	Required
`remediationId`	string	yes
`promptId`	string \| null	no
`name`	string \| null	no
`commitMessage`	string \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`POST /prompts/playground/fix-simulation`

Playground Fix Simulation

Re-score an edited system prompt against a real failing trace’s judges by replaying it. Returns a queued id to poll.

Details

Request body (application/json) — required

Field	Type	Required
`sessionId`	string	yes
`editedSystemPrompt`	string	yes
`judgeIds`	string[] \| null	no
`connectionId`	string \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`GET /prompts/playground/fix-simulation/{fixloop_id}`

Get Playground Fix Simulation

Poll a fix-loop’s status + (when completed) its before/after result.

Details

Parameters

Parameter	In	Type	Required	Description
`fixloop_id`	path	string	yes

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`POST /prompts/playground/run`

Playground Run

Execute a prompt against the project’s default LLM connection and return the output.

Details

Request body (application/json) — required

Field	Type	Required
`promptId`	string \| null	no
`label`	string \| null	no
`version`	integer \| null	no
`promptType`	string \| null	no
`content`	object \| null	no
`config`	object \| null	no
`variables`	object \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`GET /prompts/{prompt_id}`

Get Prompt

Details

Parameters

Parameter	In	Type	Required	Description
`prompt_id`	path	string	yes

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`PATCH /prompts/{prompt_id}`

Patch Prompt

Details

Parameters

Parameter	In	Type	Required	Description
`prompt_id`	path	string	yes

Request body (application/json) — required

Field	Type	Required	Description
`name`	string \| null	no
`description`	string \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`DELETE /prompts/{prompt_id}`

Delete Prompt

Details

Parameters

Parameter	In	Type	Required	Description
`prompt_id`	path	string	yes

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`PUT /prompts/{prompt_id}/labels/{label}`

Set Label

Point a movable deploy tag (production/staging/…) at a specific version.

Details

Parameters

Parameter	In	Type	Required	Description
`prompt_id`	path	string	yes
`label`	path	string	yes

Request body (application/json) — required

Field	Type	Required	Description
`version`	integer	yes

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`DELETE /prompts/{prompt_id}/labels/{label}`

Delete Label

Details

Parameters

Parameter	In	Type	Required	Description
`prompt_id`	path	string	yes
`label`	path	string	yes

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`GET /prompts/{prompt_id}/versions`

List Versions

Details

Parameters

Parameter	In	Type	Required	Description
`prompt_id`	path	string	yes

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

`POST /prompts/{prompt_id}/versions`

Create Version

Details

Parameters

Parameter	In	Type	Required	Description
`prompt_id`	path	string	yes

Request body (application/json) — required

Field	Type	Required
`content`	object	yes
`config`	object \| null	no
`commitMessage`	string \| null	no
`sourceType`	string \| null	no
`sourceRef`	string \| null	no

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

Analyze Administration