Skip to content

Commit 499c939

Browse files
committed
docs(agents): add llms index
1 parent b00a8c0 commit 499c939

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

docs-site/public/llms.txt

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Codex Pooler public docs for agents
2+
3+
Canonical docs base: https://docs.codex-pooler.com/
4+
Canonical llms index: https://docs.codex-pooler.com/llms.txt
5+
6+
Primary public docs:
7+
- https://docs.codex-pooler.com/
8+
- https://docs.codex-pooler.com/getting-started/quick-start/
9+
- https://docs.codex-pooler.com/reference/runtime-routes/
10+
- https://docs.codex-pooler.com/reference/routing-strategies/
11+
12+
What Codex Pooler is:
13+
Codex Pooler is a self-hosted gateway for sharing Codex account capacity across 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.
14+
15+
Supported route families:
16+
- /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.
17+
- /v1: narrow OpenAI-compatible /v1 surface for selected SDK routes. Supported examples include /v1/models, /v1/responses, GET /v1/responses for narrow Responses websocket compatibility, /v1/chat/completions, /v1/usage, /v1/files, /v1/audio/transcriptions, /v1/images/generations, and /v1/images/edits.
18+
- /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.
19+
20+
Unsupported boundaries:
21+
- Codex Pooler does not provide full OpenAI API parity.
22+
- Unsupported /v1 routes may return deterministic OpenAI-shaped unsupported endpoint errors when explicitly routed.
23+
- Unsupported /v1 examples include /v1/embeddings, /v1/batches, /v1/moderations, /v1/fine_tuning/jobs, /v1/images/variations, response retrieve, response cancel, and response delete routes.
24+
- /v1/realtime and OpenAI Realtime SDK websocket or session routes are unsupported.
25+
- GET /v1/responses is narrow Responses websocket compatibility, not /v1/realtime support.
26+
- POST /backend-api/codex/realtime/calls is a Codex backend control-plane SDP proxy route, not OpenAI Realtime SDK compatibility.
27+
- GET /mcp stateless SSE is unavailable today.
28+
29+
Credential boundaries:
30+
- Use Pool API keys for /backend-api and /v1 runtime requests.
31+
- Use operator-owned MCP tokens for /mcp.
32+
- Do not use Pool API keys for /mcp.
33+
- Do not use MCP tokens for /backend-api or /v1.
34+
- 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.
35+
36+
Privacy boundaries:
37+
- 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.
38+
- 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.
39+
40+
Agent guidance:
41+
- Start with https://docs.codex-pooler.com/clients/codex-cli/ when configuring Codex backend clients.
42+
- Use https://docs.codex-pooler.com/reference/routing-strategies/ when configuring Pools and routing behavior.
43+
- Keep examples on http://localhost:4000 for local setup or https://pooler.example.com for deployed product examples.
44+
- Use https://docs.codex-pooler.com/ links as canonical docs URLs.

0 commit comments

Comments
 (0)