Streaming events

agent.session.environment.ready

Emitted when a hosted session environment is ready to connect.

environment: AgentSessionEnvironmentState { id, error, status, type }

The current environment state.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.environment.ready"

The type of the object. Always agent.session.environment.ready.

OBJECT

agent.session.environment.ready

{
  "type": "agent.session.environment.ready",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "environment": {
    "id": "id",
    "type": "type",
    "status": "pending",
    "error": {
      "type": "type",
      "code": "code",
      "message": "message"
    }
  }
}

agent.output.command_execution_output.delta

Emitted when command execution produces an output delta.

delta: string

The output text that was appended.

minLength0

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the command execution item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.output.command_execution_output.delta"

The type of the object. Always agent.output.command_execution_output.delta.

OBJECT

agent.output.command_execution_output.delta

{
  "type": "agent.output.command_execution_output.delta",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "delta": "delta"
}

agent.session.created

Emitted when a session is created.

event_id: string

The unique ID of the event.

minLength0

session: AgentSession { id, agent, created_at, 9 more }

The session that was created.

type: "agent.session.created"

The type of the object. Always agent.session.created.

OBJECT

agent.session.created

{
  "type": "agent.session.created",
  "event_id": "event_id",
  "session": {
    "metadata": {
      "foo": "string"
    },
    "id": "id",
    "object": "agent.session",
    "created_at": 0,
    "last_active_at": 0,
    "status": "idle",
    "required_actions": [
      {
        "type": "function_call",
        "turn_id": "turn_id",
        "call_id": "call_id",
        "name": "name",
        "arguments": {}
      }
    ],
    "error": "error",
    "agent": {
      "id": "id",
      "name": "name",
      "model": "model",
      "reasoning": {
        "effort": "none",
        "summary": "concise"
      },
      "text": {
        "format": {
          "type": "text"
        },
        "verbosity": "low"
      },
      "service_tier": "auto",
      "instructions": "instructions",
      "tools": [
        {
          "type": "function",
          "name": "name",
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "defer_loading": true
        }
      ],
      "multi_agent": {
        "enabled": true,
        "max_concurrent_subagents": 1
      }
    },
    "environment": {
      "type": "none"
    },
    "vault_ids": [
      "string"
    ],
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  }
}

agent.session.turn.created

Emitted when a turn is created.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn: Turn { id, agent_id, completed_at, 8 more }

The turn at the time it was created.

turn_id: string

The ID of the turn associated with the event.

minLength0

type: "agent.session.turn.created"

The type of the object. Always agent.session.turn.created.

OBJECT

agent.session.turn.created

{
  "type": "agent.session.turn.created",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "turn": {
    "id": "id",
    "object": "agent.session.turn",
    "session_id": "session_id",
    "agent_id": "agent_id",
    "subagent_id": "subagent_id",
    "status": "queued",
    "created_at": 0,
    "started_at": 0,
    "completed_at": 0,
    "error": {
      "code": "context_length_exceeded",
      "message": "message"
    },
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  }
}

agent.session.turn.in_progress

Emitted when a turn starts running.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn: Turn { id, agent_id, completed_at, 8 more }

The turn at the time it started running.

turn_id: string

The ID of the turn associated with the event.

minLength0

type: "agent.session.turn.in_progress"

The type of the object. Always agent.session.turn.in_progress.

OBJECT

agent.session.turn.in_progress

{
  "type": "agent.session.turn.in_progress",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "turn": {
    "id": "id",
    "object": "agent.session.turn",
    "session_id": "session_id",
    "agent_id": "agent_id",
    "subagent_id": "subagent_id",
    "status": "queued",
    "created_at": 0,
    "started_at": 0,
    "completed_at": 0,
    "error": {
      "code": "context_length_exceeded",
      "message": "message"
    },
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  }
}

agent.session.turn.completed

Emitted when a turn completes.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn: Turn { id, agent_id, completed_at, 8 more }

The completed turn.

turn_id: string

The ID of the turn associated with the event.

minLength0

type: "agent.session.turn.completed"

The type of the object. Always agent.session.turn.completed.

usage: TokenUsage { input_tokens, input_tokens_details, output_tokens, 2 more } or null

Recorded token usage for a session or turn. Usage is best effort and may change.

OBJECT

agent.session.turn.completed

{
  "type": "agent.session.turn.completed",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "turn": {
    "id": "id",
    "object": "agent.session.turn",
    "session_id": "session_id",
    "agent_id": "agent_id",
    "subagent_id": "subagent_id",
    "status": "queued",
    "created_at": 0,
    "started_at": 0,
    "completed_at": 0,
    "error": {
      "code": "context_length_exceeded",
      "message": "message"
    },
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  },
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

agent.session.turn.failed

Emitted when a turn fails.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn: Turn { id, agent_id, completed_at, 8 more }

The failed turn.

turn_id: string

The ID of the turn associated with the event.

minLength0

type: "agent.session.turn.failed"

The type of the object. Always agent.session.turn.failed.

usage: TokenUsage { input_tokens, input_tokens_details, output_tokens, 2 more } or null

Recorded token usage for a session or turn. Usage is best effort and may change.

OBJECT

agent.session.turn.failed

{
  "type": "agent.session.turn.failed",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "turn": {
    "id": "id",
    "object": "agent.session.turn",
    "session_id": "session_id",
    "agent_id": "agent_id",
    "subagent_id": "subagent_id",
    "status": "queued",
    "created_at": 0,
    "started_at": 0,
    "completed_at": 0,
    "error": {
      "code": "context_length_exceeded",
      "message": "message"
    },
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  },
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

agent.session.turn.cancelled

Emitted when a turn is cancelled.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn: Turn { id, agent_id, completed_at, 8 more }

The cancelled turn.

turn_id: string

The ID of the turn associated with the event.

minLength0

type: "agent.session.turn.cancelled"

The type of the object. Always agent.session.turn.cancelled.

usage: TokenUsage { input_tokens, input_tokens_details, output_tokens, 2 more } or null

Recorded token usage for a session or turn. Usage is best effort and may change.

OBJECT

agent.session.turn.cancelled

{
  "type": "agent.session.turn.cancelled",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "turn": {
    "id": "id",
    "object": "agent.session.turn",
    "session_id": "session_id",
    "agent_id": "agent_id",
    "subagent_id": "subagent_id",
    "status": "queued",
    "created_at": 0,
    "started_at": 0,
    "completed_at": 0,
    "error": {
      "code": "context_length_exceeded",
      "message": "message"
    },
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  },
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

agent.session.turn.item.added

Emitted when an item is added to a turn.

event_id: string

The unique ID of the event.

minLength0

item: AgentSessionItem

The item that was added.

output_index: number or null

The index of the item in the turn output, when the item is agent output.

formatint64

minimum0

maximum4294967295

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.item.added"

The type of the object. Always agent.session.turn.item.added.

OBJECT

agent.session.turn.item.added

{
  "type": "agent.session.turn.item.added",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "output_index": 0,
  "item": {
    "type": "message",
    "id": "id",
    "turn_id": "turn_id",
    "role": "user",
    "content": [
      {
        "type": "input_text",
        "text": "text"
      }
    ],
    "status": "in_progress",
    "phase": "commentary"
  }
}

agent.session.idle

Emitted when a session becomes idle.

event_id: string

The unique ID of the event.

minLength0

session: AgentSession { id, agent, created_at, 9 more }

The session that became idle.

type: "agent.session.idle"

The type of the object. Always agent.session.idle.

OBJECT

agent.session.idle

{
  "type": "agent.session.idle",
  "event_id": "event_id",
  "session": {
    "metadata": {
      "foo": "string"
    },
    "id": "id",
    "object": "agent.session",
    "created_at": 0,
    "last_active_at": 0,
    "status": "idle",
    "required_actions": [
      {
        "type": "function_call",
        "turn_id": "turn_id",
        "call_id": "call_id",
        "name": "name",
        "arguments": {}
      }
    ],
    "error": "error",
    "agent": {
      "id": "id",
      "name": "name",
      "model": "model",
      "reasoning": {
        "effort": "none",
        "summary": "concise"
      },
      "text": {
        "format": {
          "type": "text"
        },
        "verbosity": "low"
      },
      "service_tier": "auto",
      "instructions": "instructions",
      "tools": [
        {
          "type": "function",
          "name": "name",
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "defer_loading": true
        }
      ],
      "multi_agent": {
        "enabled": true,
        "max_concurrent_subagents": 1
      }
    },
    "environment": {
      "type": "none"
    },
    "vault_ids": [
      "string"
    ],
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  }
}

agent.session.in_progress

Emitted when a session starts processing a turn.

event_id: string

The unique ID of the event.

minLength0

session: AgentSession { id, agent, created_at, 9 more }

The session that started processing.

type: "agent.session.in_progress"

The type of the object. Always agent.session.in_progress.

OBJECT

agent.session.in_progress

{
  "type": "agent.session.in_progress",
  "event_id": "event_id",
  "session": {
    "metadata": {
      "foo": "string"
    },
    "id": "id",
    "object": "agent.session",
    "created_at": 0,
    "last_active_at": 0,
    "status": "idle",
    "required_actions": [
      {
        "type": "function_call",
        "turn_id": "turn_id",
        "call_id": "call_id",
        "name": "name",
        "arguments": {}
      }
    ],
    "error": "error",
    "agent": {
      "id": "id",
      "name": "name",
      "model": "model",
      "reasoning": {
        "effort": "none",
        "summary": "concise"
      },
      "text": {
        "format": {
          "type": "text"
        },
        "verbosity": "low"
      },
      "service_tier": "auto",
      "instructions": "instructions",
      "tools": [
        {
          "type": "function",
          "name": "name",
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "defer_loading": true
        }
      ],
      "multi_agent": {
        "enabled": true,
        "max_concurrent_subagents": 1
      }
    },
    "environment": {
      "type": "none"
    },
    "vault_ids": [
      "string"
    ],
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  }
}

agent.session.requires_action

Emitted when a session is waiting for one or more required actions.

event_id: string

The unique ID of the event.

minLength0

session: AgentSession { id, agent, created_at, 9 more }

The session and its current required actions.

type: "agent.session.requires_action"

The type of the object. Always agent.session.requires_action.

OBJECT

agent.session.requires_action

{
  "type": "agent.session.requires_action",
  "event_id": "event_id",
  "session": {
    "metadata": {
      "foo": "string"
    },
    "id": "id",
    "object": "agent.session",
    "created_at": 0,
    "last_active_at": 0,
    "status": "idle",
    "required_actions": [
      {
        "type": "function_call",
        "turn_id": "turn_id",
        "call_id": "call_id",
        "name": "name",
        "arguments": {}
      }
    ],
    "error": "error",
    "agent": {
      "id": "id",
      "name": "name",
      "model": "model",
      "reasoning": {
        "effort": "none",
        "summary": "concise"
      },
      "text": {
        "format": {
          "type": "text"
        },
        "verbosity": "low"
      },
      "service_tier": "auto",
      "instructions": "instructions",
      "tools": [
        {
          "type": "function",
          "name": "name",
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "defer_loading": true
        }
      ],
      "multi_agent": {
        "enabled": true,
        "max_concurrent_subagents": 1
      }
    },
    "environment": {
      "type": "none"
    },
    "vault_ids": [
      "string"
    ],
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  }
}

agent.session.failed

Emitted when a session fails.

event_id: string

The unique ID of the event.

minLength0

session: AgentSession { id, agent, created_at, 9 more }

The failed session.

type: "agent.session.failed"

The type of the object. Always agent.session.failed.

OBJECT

agent.session.failed

{
  "type": "agent.session.failed",
  "event_id": "event_id",
  "session": {
    "metadata": {
      "foo": "string"
    },
    "id": "id",
    "object": "agent.session",
    "created_at": 0,
    "last_active_at": 0,
    "status": "idle",
    "required_actions": [
      {
        "type": "function_call",
        "turn_id": "turn_id",
        "call_id": "call_id",
        "name": "name",
        "arguments": {}
      }
    ],
    "error": "error",
    "agent": {
      "id": "id",
      "name": "name",
      "model": "model",
      "reasoning": {
        "effort": "none",
        "summary": "concise"
      },
      "text": {
        "format": {
          "type": "text"
        },
        "verbosity": "low"
      },
      "service_tier": "auto",
      "instructions": "instructions",
      "tools": [
        {
          "type": "function",
          "name": "name",
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "defer_loading": true
        }
      ],
      "multi_agent": {
        "enabled": true,
        "max_concurrent_subagents": 1
      }
    },
    "environment": {
      "type": "none"
    },
    "vault_ids": [
      "string"
    ],
    "usage": {
      "input_tokens": 0,
      "input_tokens_details": {
        "cached_tokens": 0
      },
      "output_tokens": 0,
      "output_tokens_details": {
        "reasoning_tokens": 0
      },
      "total_tokens": 0
    }
  }
}

agent.session.environment.pending

Emitted while a session environment is being prepared.

environment: AgentSessionEnvironmentState { id, error, status, type }

The current environment state.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.environment.pending"

The type of the object. Always agent.session.environment.pending.

OBJECT

agent.session.environment.pending

{
  "type": "agent.session.environment.pending",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "environment": {
    "id": "id",
    "type": "type",
    "status": "pending",
    "error": {
      "type": "type",
      "code": "code",
      "message": "message"
    }
  }
}

agent.session.environment.connected

Emitted when a session environment connects.

environment: AgentSessionEnvironmentState { id, error, status, type }

The current environment state.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.environment.connected"

The type of the object. Always agent.session.environment.connected.

OBJECT

agent.session.environment.connected

{
  "type": "agent.session.environment.connected",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "environment": {
    "id": "id",
    "type": "type",
    "status": "pending",
    "error": {
      "type": "type",
      "code": "code",
      "message": "message"
    }
  }
}

agent.session.environment.disconnected

Emitted when a session environment disconnects.

environment: AgentSessionEnvironmentState { id, error, status, type }

The current environment state.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.environment.disconnected"

The type of the object. Always agent.session.environment.disconnected.

OBJECT

agent.session.environment.disconnected

{
  "type": "agent.session.environment.disconnected",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "environment": {
    "id": "id",
    "type": "type",
    "status": "pending",
    "error": {
      "type": "type",
      "code": "code",
      "message": "message"
    }
  }
}

agent.session.environment.failed

Emitted when a session environment fails.

environment: AgentSessionEnvironmentState { id, error, status, type }

The current environment state.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.environment.failed"

The type of the object. Always agent.session.environment.failed.

OBJECT

agent.session.environment.failed

{
  "type": "agent.session.environment.failed",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "environment": {
    "id": "id",
    "type": "type",
    "status": "pending",
    "error": {
      "type": "type",
      "code": "code",
      "message": "message"
    }
  }
}

agent.session.subagent.created

Emitted when a subagent is created.

event_id: string

The unique ID of the event.

minLength0

subagent: Subagent { id, closed_at, instructions, 6 more }

The subagent that was created.

type: "agent.session.subagent.created"

The type of the object. Always agent.session.subagent.created.

OBJECT

agent.session.subagent.created

{
  "type": "agent.session.subagent.created",
  "event_id": "event_id",
  "subagent": {
    "id": "id",
    "object": "agent.session.subagent",
    "session_id": "session_id",
    "name": "name",
    "instructions": [
      {
        "type": "output_text",
        "text": "text"
      }
    ],
    "parent_agent_id": "parent_agent_id",
    "status": "active",
    "opened_at": 0,
    "closed_at": 0
  }
}

agent.session.subagent.active

Emitted when a closed subagent successfully resumes.

event_id: string

The unique ID of the event.

minLength0

subagent: Subagent { id, closed_at, instructions, 6 more }

The subagent that resumed.

type: "agent.session.subagent.active"

The type of the object. Always agent.session.subagent.active.

OBJECT

agent.session.subagent.active

{
  "type": "agent.session.subagent.active",
  "event_id": "event_id",
  "subagent": {
    "id": "id",
    "object": "agent.session.subagent",
    "session_id": "session_id",
    "name": "name",
    "instructions": [
      {
        "type": "output_text",
        "text": "text"
      }
    ],
    "parent_agent_id": "parent_agent_id",
    "status": "active",
    "opened_at": 0,
    "closed_at": 0
  }
}

agent.session.subagent.closed

Emitted when a subagent is closed.

event_id: string

The unique ID of the event.

minLength0

subagent: Subagent { id, closed_at, instructions, 6 more }

The subagent that was closed.

type: "agent.session.subagent.closed"

The type of the object. Always agent.session.subagent.closed.

OBJECT

agent.session.subagent.closed

{
  "type": "agent.session.subagent.closed",
  "event_id": "event_id",
  "subagent": {
    "id": "id",
    "object": "agent.session.subagent",
    "session_id": "session_id",
    "name": "name",
    "instructions": [
      {
        "type": "output_text",
        "text": "text"
      }
    ],
    "parent_agent_id": "parent_agent_id",
    "status": "active",
    "opened_at": 0,
    "closed_at": 0
  }
}

agent.session.turn.item.done

Emitted when an output item is complete.

event_id: string

The unique ID of the event.

minLength0

item: AgentOutputItem

The completed output item.

output_index: number

The index of the output item in the turn output.

formatint64

minimum0

maximum4294967295

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.item.done"

The type of the object. Always agent.session.turn.item.done.

OBJECT

agent.session.turn.item.done

{
  "type": "agent.session.turn.item.done",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "output_index": 0,
  "item": {
    "type": "message",
    "id": "id",
    "turn_id": "turn_id",
    "role": "assistant",
    "status": "in_progress",
    "content": [
      {
        "type": "output_text",
        "text": "text"
      }
    ],
    "phase": "commentary"
  }
}

agent.session.turn.content_part.added

Emitted when an output text content part is added.

content_index: number

The index of the content part in the message.

formatint64

minimum0

maximum4294967295

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the message item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

part: OutputText { text, type }

The initial content part.

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.content_part.added"

The type of the object. Always agent.session.turn.content_part.added.

OBJECT

agent.session.turn.content_part.added

{
  "type": "agent.session.turn.content_part.added",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "content_index": 0,
  "part": {
    "type": "output_text",
    "text": "text"
  }
}

agent.session.turn.content_part.done

Emitted when an output content part is complete.

content_index: number

The index of the content part in the message.

formatint64

minimum0

maximum4294967295

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the message item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

part: OutputText { text, type }

The completed content part.

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.content_part.done"

The type of the object. Always agent.session.turn.content_part.done.

OBJECT

agent.session.turn.content_part.done

{
  "type": "agent.session.turn.content_part.done",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "content_index": 0,
  "part": {
    "type": "output_text",
    "text": "text"
  }
}

agent.session.turn.output_text.delta

Emitted when text is appended to an output text content part.

content_index: number

The index of the content part in the message.

formatint64

minimum0

maximum4294967295

delta: string

The text that was appended.

minLength0

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the message item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

session_id: string

The ID of the session associated with the event.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.output_text.delta"

The type of the object. Always agent.session.turn.output_text.delta.

OBJECT

agent.session.turn.output_text.delta

{
  "type": "agent.session.turn.output_text.delta",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "content_index": 0,
  "delta": "delta"
}

agent.session.turn.output_text.done

Emitted when an output text content part is complete.

content_index: number

The index of the content part in the message.

formatint64

minimum0

maximum4294967295

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the message item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

session_id: string

The ID of the session associated with the event.

minLength0

text: string

The complete output text.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.output_text.done"

The type of the object. Always agent.session.turn.output_text.done.

OBJECT

agent.session.turn.output_text.done

{
  "type": "agent.session.turn.output_text.done",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "content_index": 0,
  "text": "text"
}

agent.session.turn.reasoning_summary_part.added

Emitted when a reasoning summary content part is added.

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the reasoning item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

part: SummaryText { text, type }

The initial summary part.

session_id: string

The ID of the session associated with the event.

minLength0

summary_index: number

The index of the summary content part.

formatint64

minimum0

maximum4294967295

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.reasoning_summary_part.added"

The type of the object. Always agent.session.turn.reasoning_summary_part.added.

OBJECT

agent.session.turn.reasoning_summary_part.added

{
  "type": "agent.session.turn.reasoning_summary_part.added",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "summary_index": 0,
  "part": {
    "type": "summary_text",
    "text": "text"
  }
}

agent.session.turn.reasoning_summary_part.done

Emitted when a reasoning summary part is complete.

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the reasoning item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

part: SummaryText { text, type }

The completed summary part.

session_id: string

The ID of the session associated with the event.

minLength0

status: "incomplete" or null

Present as incomplete when summary generation was interrupted.

summary_index: number

The index of the summary part.

formatint64

minimum0

maximum4294967295

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.reasoning_summary_part.done"

The type of the object. Always agent.session.turn.reasoning_summary_part.done.

OBJECT

agent.session.turn.reasoning_summary_part.done

{
  "type": "agent.session.turn.reasoning_summary_part.done",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "summary_index": 0,
  "part": {
    "type": "summary_text",
    "text": "text"
  },
  "status": "incomplete"
}

agent.session.turn.reasoning_summary_text.delta

Emitted when text is appended to a reasoning summary.

delta: string

The summary text that was appended.

minLength0

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the reasoning item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

session_id: string

The ID of the session associated with the event.

minLength0

summary_index: number

The index of the summary content part.

formatint64

minimum0

maximum4294967295

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.reasoning_summary_text.delta"

The type of the object. Always agent.session.turn.reasoning_summary_text.delta.

OBJECT

agent.session.turn.reasoning_summary_text.delta

{
  "type": "agent.session.turn.reasoning_summary_text.delta",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "summary_index": 0,
  "delta": "delta"
}

agent.session.turn.reasoning_summary_text.done

Emitted when a reasoning summary content part is complete.

event_id: string

The unique ID of the event.

minLength0

item_id: string

The ID of the reasoning item.

minLength0

output_index: number

The index of the item in the turn output.

formatint64

minimum0

maximum4294967295

session_id: string

The ID of the session associated with the event.

minLength0

summary_index: number

The index of the summary content part.

formatint64

minimum0

maximum4294967295

text: string

The complete reasoning summary text.

minLength0

turn_id: string or null

The ID of the turn associated with the event, when applicable.

minLength0

type: "agent.session.turn.reasoning_summary_text.done"

The type of the object. Always agent.session.turn.reasoning_summary_text.done.

OBJECT

agent.session.turn.reasoning_summary_text.done

{
  "type": "agent.session.turn.reasoning_summary_text.done",
  "event_id": "event_id",
  "session_id": "session_id",
  "turn_id": "turn_id",
  "item_id": "item_id",
  "output_index": 0,
  "summary_index": 0,
  "text": "text"
}

error

Emitted when a turn or session fails.

error: SessionError { code, message, param, type }

The error that occurred.

event_id: string

The unique ID of the event.

minLength0

session_id: string

The ID of the session associated with the event.

minLength0

type: "error"

The type of the object. Always error.

OBJECT

error

{
  "type": "error",
  "event_id": "event_123",
  "session_id": "sess_123",
  "error": {
    "type": "server_error",
    "code": null,
    "message": "The session failed due to an internal server error.",
    "param": null
  }
}