codex-app-server-sdk¶

Async Python client library for codex app-server over stdio and websocket.

This documentation is organized around:

• task-oriented guides (getting started, conversation, threads/config)
• operational behavior (timeouts, continuation, cancel, guarantees)
• complete API reference generated from source docstrings

Quick links¶

• Start here: Getting started
• Streaming semantics: Conversation APIs
• Long-running turn control: Timeouts, continuation, cancel
• Thread/model/config scope: Threads and configuration
• Ready-to-run scripts: Examples
• Method-level mapping: Protocol mapping
• Generated reference: API reference

Install¶

Install uv (if needed):

curl -LsSf https://astral.sh/uv/install.sh | sh

Install the package from PyPI:

uv add codex-app-server-sdk

Or pip-compatible install in the active environment:

uv pip install codex-app-server-sdk

Contributor docs workflow¶

Install development dependencies:

uv sync --group dev

Serve docs locally:

uv run zensical serve

Build docs:

uv run zensical build