Spiral gives your agent every tool with one account. Browse the tools →

Claude Code · Developer

How to Use OpenAI API endpoint reference in Claude Code

Returns documented parameters and response fields for an OpenAI API method. Use it to check a request or response against the official reference before implementing it.

Prompts to try with OpenAI API endpoint reference in Claude Code

Copy an example into Claude Code, or ask in your own words.

Use OpenAI API endpoint reference for POST /v1/responses and compare its documented request parameters and response fields with this project's request builder and parser.

OpenAI API endpoint referenceClaude Code
Try asking
  • Use OpenAI API endpoint reference to look this up and give me the result as a table. Save the result in ./assets.

  • Pull the latest numbers from OpenAI API endpoint reference and tell me what changed since last week.

  • Check OpenAI API endpoint reference and summarize what you find in three bullet points.

  • Pull the newest data from OpenAI API endpoint reference and give me the result as a table.

How to set up OpenAI API endpoint reference in Claude Code

Pick the way that suits you. Each takes about two minutes.

Use Spiral's MCP server

  1. Add the hosted server

    This adds Spiral to the current project. Add --scope user to use it in every project.

    claude mcp add --transport http spiral https://api.spiral.ai/mcp
  2. Sign in

    Start claude, type /mcp, choose spiral and Authenticate. Sign in to Spiral in the browser and click Authorize. No API key.

Use the Spiral skill

  1. Send Claude Code this message

    Your agent reads Spiral's skill and sets itself up.

    set up https://spiral.ai/SKILL.md
  2. Sign in or paste a key

    Approve Spiral in the browser, or give the agent a key from the console.

Use the Spiral CLI

  1. 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

  1. Create an API key

    In the console, under API keys.

  2. Run OpenAI API endpoint reference

    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_api_endpoint",
        "input": {
          "endpoint": "<endpoint>"
        }
      }'

Then paste one of the prompts above: Claude Code finds OpenAI API endpoint reference on Spiral, shows the price and runs it.

OpenAI API endpoint reference providers and prices

Spiral runs OpenAI API endpoint reference through Alexandria. Open a card for today's price, with every fee included.

AlexandriaDeveloper
OpenAI developer docs · Get api endpoint
developers-openai-com/developer-docs/get_api_endpoint

Settings you can ask for

Ask Claude Code for any of these in your prompt.

SettingAllowed valuesDefaultDescription
Include exampleson or off

Include request and response examples (each capped at 4000 characters). Default false.

Every API field of OpenAI developer docs · Get api endpoint is on its tool page: open its card above.

What can you do with OpenAI API endpoint reference in Claude Code?

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.

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.

Questions about OpenAI API endpoint reference in Claude Code

Can Claude Code use OpenAI API endpoint reference?

Yes. Add Spiral to Claude Code as an MCP server, and Claude Code can find and run OpenAI API endpoint reference like any built-in tool.

How much does OpenAI API endpoint reference cost in Claude Code?

$0.00873 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your Claude Code plan is separate.

Do I need an Alexandria account to use OpenAI API endpoint reference in Claude Code?

No. Spiral runs OpenAI API endpoint reference 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 API endpoint reference in Claude Code?

About two minutes: add the hosted server, then sign in.

Does Claude Code wait while OpenAI API endpoint reference runs?

OpenAI API endpoint reference runs in the background. Claude Code 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.

Get started

Start using OpenAI API endpoint reference in Claude Code

One Spiral account for every tool your agent needs. No subscription; you pay per run.

Paste this into Claude Code:

Set up Claude Code

set up https://spiral.ai/SKILL.md
Are you an AI agent? See setup options