docs: document exec json events (#5399)

This commit is contained in:
Thibault Sottiaux
2025-10-20 16:11:36 -07:00
committed by GitHub
parent 9c09094583
commit d2bae07687

View File

@@ -27,6 +27,7 @@ Supported event types:
- `turn.completed` - when a turn completes; includes token usage. - `turn.completed` - when a turn completes; includes token usage.
- `turn.failed` - when a turn fails; includes error details. - `turn.failed` - when a turn fails; includes error details.
- `item.started`/`item.updated`/`item.completed` - when a thread item is added/updated/completed. - `item.started`/`item.updated`/`item.completed` - when a thread item is added/updated/completed.
- `error` - when the stream reports an unrecoverable error; includes the error message.
Supported item types: Supported item types:
@@ -36,6 +37,7 @@ Supported item types:
- `file_change` - assistant making file changes. - `file_change` - assistant making file changes.
- `mcp_tool_call` - assistant calling an MCP tool. - `mcp_tool_call` - assistant calling an MCP tool.
- `web_search` - assistant performing a web search. - `web_search` - assistant performing a web search.
- `todo_list` - the agent's running plan when the plan tool is active, updating as steps change.
Typically, an `agent_message` is added at the end of the turn. Typically, an `agent_message` is added at the end of the turn.