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.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/agent/chats/string"{ "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" }, "status": "idle", "runningMessageId": "string", "lastError": "string", "createdAt": "string", "updatedAt": "string" }, "messages": [ { "id": "string", "role": "user", "parts": [], "metadata": { "seq": 0, "parentMessageId": "string", "createdAt": "string", "model": "string", "versionIndex": 0, "versionCount": 0, "versionIds": [ "string" ] } } ], "plan": { "todos": [ { "text": "string", "status": "pending" } ] } }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}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.