output-event

Generated reference page for spec/v1/schemas/events/output-event.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/events/output-event.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/events/output-event.json
• Defs: 5
• Properties: 0
• Required: 0

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/events/output-event.json",
  "$defs": {
    "OutputEventType": {
      "type": "string",
      "enum": [
        "RAW",
        "CUSTOM",
        "RUN_STARTED",
        "RUN_FINISHED",
        "RUN_ERROR",
        "STEP_STARTED",
        "STEP_FINISHED",
        "TEXT_MESSAGE_START",
        "TEXT_MESSAGE_CONTENT",
        "TEXT_MESSAGE_CHUNK",
        "TEXT_MESSAGE_END",
        "REASONING_START",
        "REASONING_MESSAGE_START",
        "REASONING_MESSAGE_CONTENT",
        "REASONING_MESSAGE_CHUNK",
        "REASONING_MESSAGE_END",
        "REASONING_ENCRYPTED_VALUE",
        "REASONING_END",
        "TOOL_CALL_START",
        "TOOL_CALL_ARGS",
        "TOOL_CALL_CHUNK",
        "TOOL_CALL_END",
        "TOOL_CALL_RESULT",
        "ACTIVITY_SNAPSHOT",
        "STATE_SNAPSHOT",
        "STATE_DELTA",
        "MESSAGES_SNAPSHOT"
      ]
    },
    "OutputEvent": {
      "type": "object",
      "required": ["type"],
      "properties": {
        "type": {
          "$ref": "#/$defs/OutputEventType"
        },
        "eventId": {
          "$ref": "../common/identity.json#/$defs/eventId"
        },
        "threadId": {
          "$ref": "../common/identity.json#/$defs/threadId"
        },
        "messageId": {
          "$ref": "../common/identity.json#/$defs/messageId"
        },
        "toolCallId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "artifactId": {
          "$ref": "../common/identity.json#/$defs/artifactId"
        },
        "name": {
          "type": "string"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/taskStatus"
        },
        "content": {},
        "delta": {},
        "result": {},
        "error": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        },
        "createdAt": {
          "$ref": "../common/identity.json#/$defs/timestamp"
        }
      },
      "additionalProperties": true
    },
    "SequencedOutputEnvelope": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runId", "threadId", "sequence", "event"],
      "properties": {
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "threadId": {
          "$ref": "../common/identity.json#/$defs/threadId"
        },
        "sequence": {
          "$ref": "../common/identity.json#/$defs/sequence"
        },
        "event": {
          "$ref": "#/$defs/OutputEvent"
        }
      }
    },
    "StreamKeepalive": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "cursor"],
      "properties": {
        "type": {
          "const": "KEEPALIVE"
        },
        "cursor": {
          "$ref": "../common/identity.json#/$defs/cursor"
        }
      }
    },
    "RunStreamTerminal": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "runId", "status"],
      "properties": {
        "type": {
          "const": "TERMINAL"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/taskStatus"
        }
      }
    }
  }
}