Clatter LabsHelp Center

What's inside a step event?

ReferenceUpdated

Each step event is one of two shapes:

{ "index": 0, "type": "message", "text": "I'll scaffold the project first." }
{ "index": 1, "type": "tool", "name": "computer_terminal", "ok": true,
  "args": "{\"cmd\":\"npm init -y\"}", "output": "Wrote to package.json" }
FieldMeaning
indexPosition of the step, starting at 0
typemessage or tool
textA message from Cosmos (capped at 4,000 characters)
nameThe tool used
okWhether the tool call succeeded
argsTool arguments as a string (capped at 400 characters)
outputTool output (capped at 600 characters)

The caps apply to the stream only. The full run is always available from GET /v1/runs/{id}.

Learn more#

Related articles

Still need help?

Tried the steps above and still stuck? Email us. We usually reply within the first hour, and always within 24 hours. A full support team is with you.

Infrastructure questions, or permanent deletion of your data
infrastructure@clatterlabs.xyz
For deleting your whole account or the data of one service.