Expand description
Native Codex app-server turns with caller-implemented dynamic tools.
Codex::start_turn preserves the standard text-and-dynamic-tool flow.
Codex::start_image_turn is a separate fresh, ephemeral, tool-free flow
that sends caller-owned image bytes as inline data URLs.
AgentTurn yields exact client-to-Codex JSONL records, dynamic tool
calls, and the completed turn. For an image turn, the turn/start
AgentEvent::ProviderInput contains the Base64-encoded image bytes and
must be handled as media-bearing data.
Structs§
- Agent
Request - One standard Codex turn request.
- Agent
Turn - Interactive handle for a running Codex turn.
- Codex
- Cloneable Codex app-server runtime.
- Codex
Config - Runtime configuration applied to every Codex app-server process.
- Completed
Turn - Successful terminal state of one Codex turn.
- Dynamic
Tool - A dynamic function exposed to Codex for a fresh thread.
- Dynamic
Tool Call - A dynamic function call requested by Codex.
- Error
- One safe runtime error.
- Image
Input - One in-memory image supplied to a dedicated image turn.
- Image
Turn Request - A fresh, ephemeral, tool-free Codex image-analysis turn.
- Token
Usage - Normalized cumulative and latest-turn token accounting.
- Tool
Result - Caller-provided result for one dynamic function call.
Enums§
- Agent
Event - Event yielded while a Codex turn is running.
- Error
Kind - Stable classification for a runtime failure.
- Image
Media Type - A supported image media type for an inline image turn.
- Reasoning
Effort - Model reasoning effort accepted by Codex.
Constants§
- DEFAULT_
CODEX_ EXECUTABLE - Default sandboxed Codex launcher.
Type Aliases§
- Result
- Result returned by this crate.