Skip to main content
PUT
Update chat

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Scopes

openid

OpenID Connect identity.

profile

Name and profile claims.

email

Email address.

offline_access

Refresh token.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

uuid
string<uuid>
required

Chat identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Request body schema.

name
string | null

Chat name.

Required string length: 1 - 255
systemPrompt
string | null

System prompt for every turn of this chat whose message does not carry its own. Null clears it.

integrationSlug
string | null

Integration of the language model for this chat's turns. Null clears it.

languageModelSlug
string | null

Language model for this chat's turns. Null clears it.

connectorUuid
string<uuid> | null

Connector for the language model of this chat's turns. Null clears it.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
effort
enum<string> | null

How hard the model thinks: a coding harness's effort (Codex's reasoning effort; OpenCode ignores it), or the provider's reasoning effort on a plain model call when reasoning is on.

Available options:
low,
medium,
high,
xhigh,
max
pullRequestWakes
Pull request wakes · object | null

What wakes this chat on a pull request it opened, besides a mention of the app. Null clears it.

Response

Update chat

chat
Chat · object
required

Updated chat details.