mirror of
https://github.com/openai/codex.git
synced 2026-10-20 17:38:45 +00:00
Adam Perry @ OpenAI
3b6ab3471a
## What changed - Reformat Markdown tables and lists, login pages, inline visualization HTML, and sample JavaScript scripts. - Escape union-type pipes in Python SDK API tables so they render within their cells. - Keep the formatting-recipe test focused on the working directory and formatter commands by removing assertions on comment text. GitOrigin-RevId: ae46d5b40fd013553de8b5ccf2c41d76be65aba8
31 lines
1.8 KiB
Markdown
31 lines
1.8 KiB
Markdown
# codex-api
|
|
|
|
Typed clients for Codex/OpenAI APIs built on top of the generic transport in `codex-client`.
|
|
|
|
- Hosts the request/response models and request builders for Responses and related Codex APIs.
|
|
- Owns provider configuration (base URLs, headers, query params), auth header injection, retry tuning, and stream idle settings.
|
|
- Parses SSE streams into `ResponseEvent`/`ResponseStream`, including rate-limit snapshots and API-specific error mapping.
|
|
- Serves as the wire-level layer consumed by `codex-core`; higher layers handle auth refresh and business logic.
|
|
|
|
## Core interface
|
|
|
|
The public interface of this crate is intentionally small and uniform:
|
|
|
|
- **Responses endpoint**
|
|
|
|
- Input:
|
|
- `ResponsesApiRequest` for the request body (`model`, `input`, `tools`, `parallel_tool_calls`, reasoning/text controls).
|
|
- `ResponsesOptions` for transport/header concerns (`conversation_id`, `session_source`, `extra_headers`, `compression`, `turn_state`).
|
|
- Output: a `ResponseStream` of `ResponseEvent` (both re-exported from `common`).
|
|
|
|
- **Memory summarize endpoint**
|
|
- Input: `MemorySummarizeInput` (re-exported as `codex_api::MemorySummarizeInput`):
|
|
- `model: String`.
|
|
- `raw_memories: Vec<RawMemory>` (serialized as `traces` for wire compatibility).
|
|
- `RawMemory` includes `id`, `metadata.source_path`, and normalized `items`.
|
|
- `reasoning: Option<Reasoning>`.
|
|
- Output: `Vec<MemorySummarizeOutput>`.
|
|
- `MemoriesClient::summarize_input(&MemorySummarizeInput, extra_headers)` wraps JSON encoding and retry/telemetry wiring.
|
|
|
|
All HTTP details (URLs, headers, retry/backoff policies, SSE framing) are encapsulated in `codex-api` and `codex-client`. Callers construct prompts/inputs using protocol types and work with typed streams of `ResponseEvent` or other endpoint-specific response values.
|