How to Use OpenAI documentation page in Windsurf
Returns an official OpenAI guide, reference, or cookbook page as Markdown, with an outline and section reads. Use it when you need the explanation behind a specification or reference entry.
Prompts to try with OpenAI documentation page in Windsurf
Copy an example into Windsurf, or ask in your own words.
Use OpenAI documentation page to read api/docs/guides/structured-outputs and review this project's JSON extraction code against the guide.
Use OpenAI documentation page to look this up and give me the result as a table. Save the result in ./assets.
Pull the latest numbers from OpenAI documentation page and tell me what changed since last week.
Check OpenAI documentation page and summarize what you find in three bullet points.
Pull the newest data from OpenAI documentation page and give me the result as a table.
How to set up OpenAI documentation page in Windsurf
Pick the way that suits you. Each takes about two minutes.
Use Spiral's MCP server
- Add the server
Open the Customize page from the Agents window and click MCPs. Under This computer, open the config file, or edit it directly: ~/.config/devin/mcp_config.json on macOS and Linux, %APPDATA%\devin\mcp_config.json on Windows. Add this:
{ "mcpServers": { "spiral": { "url": "https://api.spiral.ai/mcp" } } } - Sign in
Click Authenticate on the Spiral server in Customize › MCPs, or let the agent call Spiral once: your browser opens. Sign in to Spiral, pick the organization and click Authorize. No API key.
devin mcp login spiral
- Check it
Spiral is listed under This computer in Customize › MCPs. From the terminal:
devin mcp list
Use the Spiral skill
- Send Windsurf 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 page
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/get_page", "input": { "path": "<path>" } }'
Then paste one of the prompts above: Windsurf finds OpenAI documentation page on Spiral, shows the price and runs it.
OpenAI documentation page providers and prices
Spiral runs OpenAI documentation page through Alexandria. Open a card for today's price, with every fee included.
Settings you can ask for
Ask Windsurf for any of these in your prompt.
| Setting | Allowed values | Default | Description |
|---|---|---|---|
| Max chars | 200 to 2000000 | Truncate content to this many characters (default 40000). |
Every API field of OpenAI developer docs · Get page is on its tool page: open its card above.
What can you do with OpenAI documentation page in Windsurf?
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 page and Windsurf
Overview
OpenAI documentation page in other agents
Questions about OpenAI documentation page in Windsurf
Can Windsurf use OpenAI documentation page?
Yes. Add Spiral to Windsurf as an MCP server, and Windsurf can find and run OpenAI documentation page like any built-in tool.
How much does OpenAI documentation page cost in Windsurf?
$0.00873 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your Windsurf plan is separate.
Do I need an Alexandria account to use OpenAI documentation page in Windsurf?
No. Spiral runs OpenAI documentation page 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 page in Windsurf?
About two minutes: add the server, then sign in, then check it.
Does Windsurf wait while OpenAI documentation page runs?
OpenAI documentation page runs in the background. Windsurf 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 page in Windsurf
One Spiral account for every tool your agent needs. No subscription; you pay per run.
Paste this into Windsurf:
set up https://spiral.ai/SKILL.md


