mirror of https://github.com/openai/codex.git synced 2026-08-23 13:09:46 +00:00

Files

Eric Traut 2edad72de3 Track prompt cache write token usage (#33454 )

## What changed

- Parse `cache_write_tokens` from response input token details and carry it through token usage aggregation.
- Expose `cache_write_input_tokens` in protocol, app-server, exec, and TypeScript SDK usage events, defaulting it to zero for compatibility with older payloads.
- Report cache-write usage in analytics, metrics, traces, and rollout data alongside existing cache-read usage.

## Testing

- Add coverage for response parsing, usage event output, aggregation, analytics, metrics, and telemetry fields.

GitOrigin-RevId: 634e4fbe3086a8923c0ee13b622573e7d9d221bd

2026-07-16 00:22:53 +00:00

src

Track prompt cache write token usage (#33454 )

2026-07-16 00:22:53 +00:00

tests

Require prefixes for outbound response item IDs (#32312 )

2026-07-11 02:29:14 +00:00

BUILD.bazel

feat: add support for building with Bazel (#8875 )

2026-01-09 11:09:43 -08:00

Cargo.toml

Improve file blob upload diagnostics (#32305 )

2026-07-11 01:46:27 +00:00

README.md

Remove ApiPrompt (#11265 )

2026-02-10 16:12:31 +00:00

README.md

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 Compact 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, instructions, 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).
Compaction endpoint
- Input: CompactionInput<'a> (re-exported as codex_api::CompactionInput):
  - model: &str.
  - input: &[ResponseItem] – history to compact.
  - instructions: &str – fully-resolved compaction instructions.
- Output: Vec<ResponseItem>.
- CompactClient::compact_input(&CompactionInput, extra_headers) wraps the JSON encoding and retry/telemetry wiring.
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 compacted ResponseItem values.

README.md Unescape Escape

codex-api

Core interface

README.md