How to Use OpenAI documentation search in Codex
Returns search results from OpenAI's public documentation service. Use it to locate the guide or reference page that answers a question before reading the page itself.
Prompts to try with OpenAI documentation search in Codex
Copy an example into Codex, or ask in your own words.
Use OpenAI documentation search to look this up and give me the result as a table. Save the result in ./assets.
Pull the latest numbers from OpenAI documentation search and tell me what changed since last week.
Check OpenAI documentation search and summarize what you find in three bullet points.
Pull the newest data from OpenAI documentation search and give me the result as a table.
Check OpenAI documentation search every morning and tell me only when something changed.
How to set up OpenAI documentation search in Codex
Pick the way that suits you. Each takes about two minutes.
Use Spiral's MCP server
- Add the hosted server
codex mcp add spiral --url https://api.spiral.ai/mcp
- Sign in
Codex opens the browser: sign in to Spiral and click Authorize. No API key. codex mcp list then shows Spiral.
codex mcp login spiral
Use the Spiral skill
- Send Codex this message
Your agent reads Spiral's skill and sets itself up.
set up https://spiral.ai/SKILL.md
- Sign in or paste a key
Approve Spiral in the browser, or give the agent a key from the console.
Use the Spiral CLI
- Install and sign in
Installs the Spiral CLI, signs you in and adds its skill to your coding agents.
npx -y spiral-cli@latest init
Call the Spiral API
- Create an API key
In the console, under API keys.
- Run OpenAI documentation search
One request; the result comes back by polling or a webhook.
curl https://api.spiral.ai/v1/runs \ -H "Authorization: Bearer $SPIRAL_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{ "provider": "alexandria", "model": "developers-openai-com/developer-docs/search_docs", "input": { "query": "<query>" } }'
Then paste one of the prompts above: Codex finds OpenAI documentation search on Spiral, shows the price and runs it.
OpenAI documentation search providers and prices
Spiral runs OpenAI documentation search through Alexandria. Open a card for today's price, with every fee included.
Settings you can ask for
Ask Codex for any of these in your prompt.
| Setting | Allowed values | Default | Description |
|---|---|---|---|
| Site | api or all | api (default): developers.openai.com and platform.openai.com hits; all: every host the server indexes. | |
| Limit | 1 to 50 | Hits requested from the server (default 10). Filtering by site can return fewer. |
Every API field of OpenAI developer docs · Search docs is on its tool page: open its card above.
What can you do with OpenAI documentation search in Codex?
Produce an OpenAI integration review tied to the project's actual requests and model choices. A coding agent can compare those choices with official specifications, reference fields, guides, and dated announcements before proposing edits.
Plan a Chat Completions migration
Build a migration checklist from dated API changes, request and response definitions, model capabilities, retirement notices, and published billing categories. Link each proposed code change to the relevant guide.
Write a model selection decision
Evaluate models for a document extraction application using catalog entries, specifications, endpoint definitions, lifecycle notices, billing units, and implementation guides. Include recent announcements that affect the decision.
Check a Responses API implementation
Compare a request builder and response parser with the documented method, then read the guides for the features the application uses. Check model specifications and dated changes when behavior depends on the selected model.
Prepare a release readiness review
Before shipping an OpenAI integration, review its selected models, documented limits, API schemas, lifecycle status, and billing assumptions. Use the changelog and guides to identify documentation changes that need engineering review.
Maintain an internal API reference
Update an engineering reference with documented request parameters, response fields, and explanations from official guides. Add dated changelog entries when they explain a change in the reference.
Check workload sizing assumptions
Compare candidate models' context, input, and output limits with the application's expected document sizes. Review the published token billing categories and relevant guides before building an estimate.
Prepare retirement handoff briefs
Turn announced shutdowns into engineering handoff briefs with affected model IDs, proposed replacements, specification differences, schema checks, and billing considerations. Include migration guides and related announcements.
Investigate request compatibility errors
Check a failing OpenAI request against the method reference and selected model's specifications. Read the relevant guide and dated announcements to identify documented compatibility changes.
More on OpenAI documentation search and Codex
Overview
OpenAI documentation search in other agents
Questions about OpenAI documentation search in Codex
Can Codex use OpenAI documentation search?
Yes. Add Spiral to Codex as an MCP server, and Codex can find and run OpenAI documentation search like any built-in tool.
How much does OpenAI documentation search cost in Codex?
$0.00873 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your Codex plan is separate.
Do I need an Alexandria account to use OpenAI documentation search in Codex?
No. Spiral runs OpenAI documentation search on its own Alexandria account. You sign in to Spiral once and never paste a key.
How long does it take to set up OpenAI documentation search in Codex?
About two minutes: add the hosted server, then sign in.
Does Codex wait while OpenAI documentation search runs?
OpenAI documentation search runs in the background. Codex starts the run, checks on it and gives you the json when it's ready.
What public material does this source cover?
OpenAI's documentation service provides read-only search and page content. The page reader covers official guides, references, and cookbook pages.
Does the model catalog include deprecated models?
Yes. OpenAI explicitly includes deprecated models in its full catalog, so a listed model still needs a lifecycle check.
How detailed are the model specifications?
They distinguish context capacity from input and output limits. For example, GPT-6.2 Sol lists a 1,050,000-token context window, 922,000 maximum input tokens, and 128,000 maximum output tokens.
Are API announcements dated?
Yes. The changelog's November 17, 2026 entry identifies GPT-6.2 Astra and GPT-6.2 Sol and tags the Responses and Chat Completions APIs.
Can an agent read a specific part of a guide?
Yes. The documentation page reader provides Markdown content with an outline and section reads for guides, references, and cookbook pages.
Start using OpenAI documentation search in Codex
One Spiral account for every tool your agent needs. No subscription; you pay per run.
Paste this into Codex:
set up https://spiral.ai/SKILL.md


