SnozeDevelopers
API referenceAgent

Read an agent chat transcript

Returns the chat, the messages along its currently active thread with their parts, and the chat's plan when it has one. Requires a Clerk session for a workspace member with the `ai:read` permission; a chat that does not exist, or belongs to another user, is reported as not found. Live token output arrives on the separate streaming routes rather than here. The optional candidateTurnId verifies a stable running or terminal launch; recoveryTurnId additionally requires a terminal launch. An unstable or replaced snapshot returns a null streamIdentity and must not select a replacement reader.

GET
/v1/workspaces/{workspaceId}/agent/chats/{chatId}

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
chatId*string

Query Parameters

candidateTurnId?|null
recoveryTurnId?|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/agent/chats/string'
Example Response
{  "data": {    "chat": {      "id": "string",      "workspaceId": "string",      "title": "string",      "parentSessionId": "string",      "model": "string",      "appearance": {        "shape": "box",        "color": "string",        "accentColor": "string",        "eyes": "dot",        "eyePlacement": "centered",        "motion": "still",        "finish": "flat",        "gradientColor": "string",        "glowColor": "string",        "intensity": "subtle",        "cosmetics": {          "head": "none",          "face": "none"        }      },      "status": "idle",      "runningMessageId": "string",      "streamIdentity": {        "turnId": "string",        "messageId": "string"      },      "lastError": "string",      "background": {        "enabled": true,        "continuations": 0,        "deadlineAt": 0      },      "createdAt": "string",      "updatedAt": "string"    },    "messages": [      {        "id": "string",        "role": "user",        "parts": [],        "metadata": {          "seq": 0,          "parentMessageId": "string",          "createdAt": "string",          "model": "string",          "snozeAi": true,          "credits": 0,          "versionIndex": 0,          "versionCount": 0,          "versionIds": [            "string"          ]        }      }    ],    "plan": {      "todos": [        {          "text": "string",          "status": "pending"        }      ]    }  }}

Create an agent chat

Creates an empty chat owned by the caller, with an optional title, model, and appearance, and returns it. Requires a Clerk session for a workspace member with the `ai:write` permission. The conversation itself is driven by the separate streaming turn route, not by this operation.

Update an agent chat's title, model, or appearance

Applies a partial edit to one of the caller's own chats and returns the updated chat. Requires a Clerk session for a workspace member with the `ai:write` permission; a chat that does not exist, or belongs to another user, is reported as not found.