Tool details
| Field | Value |
|---|---|
| Name | get_agent_run_snapshot |
| Group | Conversations |
Playground
Input schema
input-schema.json
{
"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."
}
},
"additionalProperties": false,
"description": "Input schema for the get_agent_run_snapshot tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
Output schema
output-schema.json
{
"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": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TEXT_MESSAGE_START",
"description": "The type associated with this record."
},
"messageId": {
"type": "string",
"minLength": 1,
"description": "The message id associated with this record."
},
"contentId": {
"type": "string",
"minLength": 1,
"description": "The content id associated with this record."
},
"role": {
"type": "string",
"description": "The role associated with this record."
}
},
"required": [
"type",
"messageId",
"contentId"
],
"additionalProperties": true,
"description": "The option 1 associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TEXT_MESSAGE_CONTENT",
"description": "The type associated with this record."
},
"messageId": {
"type": "string",
"minLength": 1,
"description": "The message id associated with this record."
},
"contentId": {
"type": "string",
"minLength": 1,
"description": "The content id associated with this record."
},
"delta": {
"type": "string",
"description": "The delta associated with this record."
}
},
"required": [
"type",
"messageId",
"contentId",
"delta"
],
"additionalProperties": true,
"description": "The option 2 associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TEXT_MESSAGE_END",
"description": "The type associated with this record."
},
"messageId": {
"type": "string",
"minLength": 1,
"description": "The message id associated with this record."
},
"contentId": {
"type": "string",
"minLength": 1,
"description": "The content id associated with this record."
}
},
"required": [
"type",
"messageId",
"contentId"
],
"additionalProperties": true,
"description": "The option 3 associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TOOL_CALL_START",
"description": "The type associated with this record."
},
"toolCallId": {
"type": "string",
"minLength": 1,
"description": "The tool call id associated with this record."
},
"toolCallName": {
"type": "string",
"minLength": 1,
"description": "The tool call name associated with this record."
}
},
"required": [
"type",
"toolCallId",
"toolCallName"
],
"additionalProperties": true,
"description": "Structured option 4 details associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TOOL_CALL_ARGS",
"description": "The type associated with this record."
},
"toolCallId": {
"type": "string",
"minLength": 1,
"description": "The tool call id associated with this record."
},
"delta": {
"type": "string",
"description": "The delta associated with this record."
}
},
"required": [
"type",
"toolCallId",
"delta"
],
"additionalProperties": true,
"description": "Structured option 5 details associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TOOL_CALL_CHUNK",
"description": "The type associated with this record."
},
"toolCallId": {
"type": "string",
"minLength": 1,
"description": "The tool call id associated with this record."
},
"delta": {
"type": "string",
"description": "The delta associated with this record."
}
},
"required": [
"type",
"toolCallId",
"delta"
],
"additionalProperties": true,
"description": "Structured option 6 details associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TOOL_CALL_END",
"description": "The type associated with this record."
},
"toolCallId": {
"type": "string",
"minLength": 1,
"description": "The tool call id associated with this record."
}
},
"required": [
"type",
"toolCallId"
],
"additionalProperties": true,
"description": "Structured option 7 details associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "TOOL_CALL_RESULT",
"description": "The type associated with this record."
},
"messageId": {
"type": "string",
"minLength": 1,
"description": "The message id associated with this record."
},
"toolCallId": {
"type": "string",
"minLength": 1,
"description": "The tool call id associated with this record."
},
"input": {
"description": "The input associated with this record."
},
"content": {
"description": "Source content or body stored on the record."
},
"result": {
"description": "The result associated with this record."
},
"role": {
"type": "string",
"const": "tool",
"description": "The role associated with this record."
},
"isError": {
"type": "boolean",
"description": "The is error associated with this record."
}
},
"required": [
"type",
"toolCallId"
],
"additionalProperties": true,
"description": "Structured option 8 details associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "MESSAGES_SNAPSHOT",
"description": "The type associated with this record."
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "Unique identifier for the record."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role associated with this record."
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"minLength": 1,
"description": "The type associated with this record."
}
},
"required": [
"type"
],
"additionalProperties": true,
"description": "One part item associated with this record."
},
"description": "The parts associated with this record."
},
"content": {
"description": "Source content or body stored on the record."
}
},
"additionalProperties": true,
"description": "One message item associated with this record."
},
"description": "List of messages associated with this record."
}
},
"required": [
"type",
"messages"
],
"additionalProperties": true,
"description": "Structured option 9 details associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "STATE_SNAPSHOT",
"description": "The type associated with this record."
},
"snapshot": {
"type": "object",
"additionalProperties": {
"description": "Additional structured values associated with this result."
},
"description": "Structured snapshot details associated with this record."
}
},
"required": [
"type",
"snapshot"
],
"additionalProperties": true,
"description": "Structured option 10 details associated with this record."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "STATE_DELTA",
"description": "The type associated with this record."
},
"delta": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"description": "Additional structured values associated with this result."
},
"description": "Structured option 1 details associated with this record."
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add",
"remove",
"replace",
"move",
"copy",
"test"
],
"description": "The op associated with this record."
},
"path": {
"type": "string",
"minLength": 1,
"description": "The path associated with this record."
},
"from": {
"type": "string",
"minLength": 1,
"description": "The from associated with this record."
},
"value": {
"description": "The value associated with this record."
}
},
"required": [
"op",
"path"
],
"additionalProperties": true,
"description": "One option 2 item associated with this record."
},
"description": "List of option 2 associated with this record."
}
],
"description": "The delta associated with this record."
}
},
"required": [
"type",
"delta"
],
"additionalProperties": true,
"description": "Structured option 11 details associated with this record."
},
{
"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",
"MESSAGES_SNAPSHOT",
"STATE_SNAPSHOT",
"STATE_DELTA",
"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": "The option 12 associated with this record."
}
],
"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#"
}