Skip to content

Commit 661663c

Browse files
authored
Fix event names in exec docs. (#4833)
Fixes: https://github.com/openai/codex/issues
1 parent 721003c commit 661663c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/exec.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,25 @@ Supported event types:
3030

3131
Supported item types:
3232

33-
- `assistant_message` - assistant message.
33+
- `agent_message` - assistant message.
3434
- `reasoning` - a summary of the assistant's thinking.
3535
- `command_execution` - assistant executing a command.
3636
- `file_change` - assistant making file changes.
3737
- `mcp_tool_call` - assistant calling an MCP tool.
3838
- `web_search` - assistant performing a web search.
3939

40-
Typically, an `assistant_message` is added at the end of the turn.
40+
Typically, an `agent_message` is added at the end of the turn.
4141

4242
Sample output:
4343

4444
```jsonl
4545
{"type":"thread.started","thread_id":"0199a213-81c0-7800-8aa1-bbab2a035a53"}
4646
{"type":"turn.started"}
47-
{"type":"item.completed","item":{"id":"item_0","item_type":"reasoning","text":"**Searching for README files**"}}
48-
{"type":"item.started","item":{"id":"item_1","item_type":"command_execution","command":"bash -lc ls","aggregated_output":"","status":"in_progress"}}
49-
{"type":"item.completed","item":{"id":"item_1","item_type":"command_execution","command":"bash -lc ls","aggregated_output":"2025-09-11\nAGENTS.md\nCHANGELOG.md\ncliff.toml\ncodex-cli\ncodex-rs\ndocs\nexamples\nflake.lock\nflake.nix\nLICENSE\nnode_modules\nNOTICE\npackage.json\npnpm-lock.yaml\npnpm-workspace.yaml\nPNPM.md\nREADME.md\nscripts\nsdk\ntmp\n","exit_code":0,"status":"completed"}}
50-
{"type":"item.completed","item":{"id":"item_2","item_type":"reasoning","text":"**Checking repository root for README**"}}
51-
{"type":"item.completed","item":{"id":"item_3","item_type":"assistant_message","text":"Yep — there’s a `README.md` in the repository root."}}
47+
{"type":"item.completed","item":{"id":"item_0","type":"reasoning","text":"**Searching for README files**"}}
48+
{"type":"item.started","item":{"id":"item_1","type":"command_execution","command":"bash -lc ls","aggregated_output":"","status":"in_progress"}}
49+
{"type":"item.completed","item":{"id":"item_1","type":"command_execution","command":"bash -lc ls","aggregated_output":"2025-09-11\nAGENTS.md\nCHANGELOG.md\ncliff.toml\ncodex-cli\ncodex-rs\ndocs\nexamples\nflake.lock\nflake.nix\nLICENSE\nnode_modules\nNOTICE\npackage.json\npnpm-lock.yaml\npnpm-workspace.yaml\nPNPM.md\nREADME.md\nscripts\nsdk\ntmp\n","exit_code":0,"status":"completed"}}
50+
{"type":"item.completed","item":{"id":"item_2","type":"reasoning","text":"**Checking repository root for README**"}}
51+
{"type":"item.completed","item":{"id":"item_3","type":"agent_message","text":"Yep — there’s a `README.md` in the repository root."}}
5252
{"type":"turn.completed","usage":{"input_tokens":24763,"cached_input_tokens":24448,"output_tokens":122}}
5353
```
5454

0 commit comments

Comments
 (0)