Skip to main content
Get the durable public stream snapshot for a project-agent run.

Tool details

FieldValue
Nameget_agent_run_snapshot
GroupConversations

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "conversation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Conversation identifier that scopes the request."
    },
    "run_id": {
      "type": "string",
      "minLength": 1,
      "description": "Run identifier that scopes the request."
    }
  },
  "required": [
    "conversation_id",
    "run_id"
  ],
  "additionalProperties": false,
  "description": "Input schema for the get_agent_run_snapshot tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "after_event_id": {
      "type": "integer",
      "minimum": 0,
      "description": "Inclusive event cursor used to build the snapshot."
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "event_id": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0,
                "description": "The event id associated with this record."
              },
              {
                "type": "null",
                "description": "The event id returned by the tool."
              }
            ],
            "description": "Event identifier associated with the snapshot item, or null when synthetic."
          },
          "event": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "RUN_STARTED",
                  "RUN_FINISHED",
                  "RUN_ERROR",
                  "TEXT_MESSAGE_START",
                  "TEXT_MESSAGE_CONTENT",
                  "TEXT_MESSAGE_END",
                  "TOOL_CALL_START",
                  "TOOL_CALL_ARGS",
                  "TOOL_CALL_CHUNK",
                  "TOOL_CALL_END",
                  "TOOL_CALL_RESULT",
                  "STATE_SNAPSHOT",
                  "STATE_DELTA",
                  "MESSAGES_SNAPSHOT",
                  "STEP_STARTED",
                  "STEP_FINISHED",
                  "REASONING_START",
                  "REASONING_MESSAGE_START",
                  "REASONING_MESSAGE_CONTENT",
                  "REASONING_MESSAGE_END",
                  "REASONING_CONTENT",
                  "REASONING_END",
                  "ACTIVITY_SNAPSHOT",
                  "ACTIVITY_DELTA",
                  "CUSTOM"
                ],
                "description": "The type associated with this record."
              }
            },
            "required": [
              "type"
            ],
            "additionalProperties": true,
            "description": "AG-UI event payload captured in the run snapshot."
          }
        },
        "required": [
          "event_id",
          "event"
        ],
        "additionalProperties": false,
        "description": "One event entry inside an agent run snapshot response."
      },
      "description": "Events included in the run snapshot after the requested cursor."
    }
  },
  "required": [
    "after_event_id",
    "events"
  ],
  "additionalProperties": false,
  "description": "Snapshot of agent run events after a given event cursor.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}