SnozeDevelopers
API referenceAgent

Read the staged set of a bulk assistant write

A set-based assistant write (updating every record a filter matches, or importing rows) stages the exact records it will change before it runs; the approval card shows a sample and this pages through all of them, in staging order, with each record's field-level before and after values. The set is immutable: it is what the approved call runs. `offset` (default 0) and `limit` (1-200, default 50) select the page; `nextOffset` is present while more rows follow. Requires a Clerk session for a workspace member with the `ai:read` permission who owns the chat; an unknown chat, message, or a call that staged nothing is reported as not found.

GET
/v1/workspaces/{workspaceId}/agent/chats/{chatId}/messages/{messageId}/tool-calls/{toolCallId}/stage

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
messageId*string
toolCallId*string

Query Parameters

offset?string|null
limit?string|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/agent/chats/string/messages/string/tool-calls/string/stage'
Example Response
{  "data": {    "operation": "string",    "headline": "string",    "databaseLabel": "string",    "counts": [      {        "change": "create",        "count": 0      }    ],    "fields": [      "string"    ],    "fingerprint": "string",    "total": 0,    "offset": 0,    "rows": [      {        "ref": "string",        "title": "string",        "change": "create",        "fields": [          {            "field": "string",            "before": "string",            "after": "string"          }        ]      }    ],    "nextOffset": 0  }}

Switch which version of a message is active

Points the chat's active thread at the latest leaf beneath the given message, so a regenerated or edited branch becomes the visible conversation, and returns the resulting transcript. Requires a Clerk session for a workspace member with the `ai:write` permission; an unknown chat or a message id that is not part of it is reported as not found.

Branch an agent chat from a message

Creates a new chat seeded from the source chat's history: branching from a user message copies everything before it and returns that message's text as `seed` to re-run, while branching from an assistant message copies through it. An optional `model` overrides the branch's model. Requires a Clerk session for a workspace member with the `ai:write` permission and the `ai.agent.enabled` control switched on; an unknown chat or message is reported as not found.