# Codex Pooler Public Docs For Agents Last reviewed: 2026-06-13 Canonical docs base: https://docs.codex-pooler.com/ Canonical llms index: https://docs.codex-pooler.com/llms.txt Short answer reference: https://docs.codex-pooler.com/answers.md Pricing and availability: https://docs.codex-pooler.com/pricing.md Primary public docs: - https://docs.codex-pooler.com/ - https://docs.codex-pooler.com/getting-started/quick-start/ - https://docs.codex-pooler.com/getting-started/configuration/ - https://docs.codex-pooler.com/clients/codex-cli/ - https://docs.codex-pooler.com/clients/openai-compatible/ - https://docs.codex-pooler.com/clients/aider/ - https://docs.codex-pooler.com/clients/continue/ - https://docs.codex-pooler.com/clients/cline/ - https://docs.codex-pooler.com/clients/goose/ - https://docs.codex-pooler.com/clients/kilo/ - https://docs.codex-pooler.com/clients/opencode/ - https://docs.codex-pooler.com/clients/openclaw/ - https://docs.codex-pooler.com/clients/openhands/ - https://docs.codex-pooler.com/clients/omp/ - https://docs.codex-pooler.com/clients/pi/ - https://docs.codex-pooler.com/clients/hermes/ - https://docs.codex-pooler.com/clients/windmill/ - https://docs.codex-pooler.com/reference/runtime-routes/ - https://docs.codex-pooler.com/reference/routing-strategies/ - https://docs.codex-pooler.com/operators/admin-ui/ - https://docs.codex-pooler.com/operators/alerts/ - https://docs.codex-pooler.com/operators/monitoring/ - https://docs.codex-pooler.com/deployment/docker-compose/ - https://docs.codex-pooler.com/deployment/helm/ AI search discovery pages: - https://docs.codex-pooler.com/discovery/self-hosted-codex-gateway/ - https://docs.codex-pooler.com/discovery/codex-account-pooling/ - https://docs.codex-pooler.com/discovery/openai-compatible-codex-gateway/ - https://docs.codex-pooler.com/discovery/codex-pooler-vs-direct-credentials/ What Codex Pooler is: Codex Pooler is a self-hosted gateway for sharing Codex account capacity across trusted agents, tools, and teams. Clients use stable Pool API keys, and operators manage Pools, upstream accounts, routing, request logs, audit logs, and metadata-only MCP access. Who Codex Pooler is for: Codex Pooler is for operators and client integrators who already manage trusted Codex accounts and want shared capacity, stable client credentials, route policy, account readiness checks, and metadata-only operational evidence. It is not a hosted provider, a general OpenAI API clone, or a way to bypass account terms and limits. Client base URLs: - Codex backend-compatible clients use https://codex-pooler.example.com/backend-api/codex. - Selected OpenAI SDK-compatible clients use https://codex-pooler.example.com/v1. - Operator metadata tools use https://codex-pooler.example.com/mcp. - Local setup uses http://localhost:4000 with the same paths. Supported route families: - /backend-api: Codex backend compatibility route for authenticated Codex clients. Important paths include /backend-api/codex/models, /backend-api/codex/responses, /backend-api/codex/responses/compact, /backend-api/codex/v1/* aliases, /backend-api/files, /backend-api/transcribe, and usage routes such as /backend-api/wham/usage. - /v1: narrow OpenAI-compatible /v1 surface for selected SDK routes. Supported or translated examples include /v1/models, /v1/responses, GET /v1/responses for narrow Responses websocket compatibility, /v1/chat/completions, /v1/usage, /v1/files metadata and create routes, /v1/audio/transcriptions, /v1/images/generations, and /v1/images/edits. - /mcp: root operator MCP endpoint. POST /mcp is metadata-only, read-only Streamable HTTP JSON-RPC. It uses operator-owned MCP bearer tokens, not Pool API keys or browser sessions. Unsupported boundaries: - Codex Pooler does not provide full OpenAI API parity. - Unsupported /v1 routes may return deterministic OpenAI-shaped unsupported endpoint errors when explicitly routed. - Unsupported /v1 examples include /v1/responses/compact, /v1/files/:file_id/content, DELETE /v1/files/:file_id, /v1/embeddings, /v1/batches, /v1/moderations, /v1/fine_tuning/jobs, /v1/images/variations, response retrieve, response cancel, and response delete routes. - /v1/realtime and OpenAI Realtime SDK websocket or session routes are unsupported. - GET /v1/responses is narrow Responses websocket compatibility, not /v1/realtime support. - Codex Pooler supports Codex model-provider traffic only; it does not proxy Codex app-server helper routes. - GET /mcp stateless SSE is unavailable today. Credential boundaries: - Use Pool API keys for /backend-api and /v1 runtime requests. - Use operator-owned MCP tokens for /mcp. - Do not use Pool API keys for /mcp. - Do not use MCP tokens for /backend-api or /v1. - Do not put raw keys, tokens, cookies, auth.json, access tokens, refresh tokens, invite tokens, or upstream secrets in docs, tickets, logs, screenshots, examples, or prompts. Privacy boundaries: - Codex Pooler observability is metadata-only. Safe examples can mention route family, endpoint path, method, status class, Pool label, upstream label, model name, synthetic request-log id, error code, retry count, duration, token count, and timestamp. - Do not include raw prompts, completions, request bodies, response bodies, multipart bodies, websocket frames, file bytes, audio bytes, image bytes, data URLs, transcripts, bearer tokens, cookies, Pool API keys, MCP tokens, auth.json, access tokens, refresh tokens, raw upload URLs, raw idempotency keys, private hostnames, real account ids, raw emails, or private IP addresses. Agent guidance: - Start with https://docs.codex-pooler.com/clients/codex-cli/ when configuring Codex CLI or Codex Desktop with CODEX_HOME/config.toml, model_provider=codex-pooler-ws, and the /backend-api/codex route. - Start with https://docs.codex-pooler.com/clients/openai-compatible/ when configuring selected OpenAI SDK-compatible clients. - Use https://docs.codex-pooler.com/clients/openhands/ when configuring OpenHands CLI with environment overrides LLM_BASE_URL, LLM_MODEL=openai/gpt-5.5, --override-with-envs, and local state under ~/.openhands/. - Use https://docs.codex-pooler.com/clients/aider/ when configuring Aider with ~/.aider.conf.yml, model=openai/gpt-5.5, openai-api-base=https://codex-pooler.example.com/v1, and a Pool API key in OPENAI_API_KEY. - Use https://docs.codex-pooler.com/clients/continue/ when configuring Continue with ~/.continue/config.yaml on macOS/Linux or %USERPROFILE%\.continue\config.yaml on Windows, provider=openai, apiBase=https://codex-pooler.example.com/v1, and a Pool API key as a Continue secret. - Use https://docs.codex-pooler.com/clients/goose/ when configuring Goose with ~/.config/goose/config.yaml on macOS/Linux or %APPDATA%\Block\goose\config\config.yaml on Windows, GOOSE_PROVIDER=openai, OPENAI_HOST=https://codex-pooler.example.com, OPENAI_BASE_PATH=v1/chat/completions, and a Pool API key in OPENAI_API_KEY or Goose secret storage. - Use https://docs.codex-pooler.com/clients/kilo/ when configuring Kilo Code with ~/.config/kilo/kilo.jsonc, model=codex-pooler/gpt-5.5, provider options apiKey={env:CODEX_POOLER_API_KEY}, baseURL=https://codex-pooler.example.com/v1, and Kilo's chat-completions route shape. - Use https://docs.codex-pooler.com/clients/omp/ when configuring Oh My Pi (OMP) with ~/.omp/agent/models.yml, modelRoles in ~/.omp/agent/config.yml, api=openai-responses, authHeader=true, and a Pool API key in CODEX_POOLER_API_KEY. - Use https://docs.codex-pooler.com/clients/pi/ when configuring Pi with ~/.pi/agent/models.json, ~/.pi/agent/settings.json, api=openai-responses, authHeader=true, and a Pool API key in CODEX_POOLER_API_KEY. - Use https://docs.codex-pooler.com/discovery/self-hosted-codex-gateway/ for short answers about Codex Pooler as a self-hosted Codex gateway. - Use https://docs.codex-pooler.com/discovery/codex-account-pooling/ for short answers about Pools, upstream accounts, eligibility, and routing. - Use https://docs.codex-pooler.com/discovery/openai-compatible-codex-gateway/ for short answers about narrow /v1 SDK compatibility over Codex Pools. - Use https://docs.codex-pooler.com/discovery/codex-pooler-vs-direct-credentials/ for short answers comparing Pool API keys with direct account credentials. - Use the client-specific pages for Aider, Continue, Cline, Goose, Kilo, OpenCode, OpenClaw, OpenHands, OMP, Pi, Hermes, and Windmill setup snippets. - Use https://docs.codex-pooler.com/reference/routing-strategies/ when configuring Pools and routing behavior. - Use https://docs.codex-pooler.com/answers.md for short, citable answers about scope, routes, credentials, privacy, setup, and deployment. - Keep examples on http://localhost:4000 for local setup or https://codex-pooler.example.com for deployed product examples. - Use https://docs.codex-pooler.com/ links as canonical docs URLs.