[Integrations](https://spiral.ai/integrations) › [dots](https://spiral.ai/integrations/dots) › [OpenAI API endpoint reference](https://spiral.ai/integrations/dots/openai-api-endpoint-reference)

# How to Use OpenAI API endpoint reference in dots

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.

|  |  |
| --- | --- |
| Model | OpenAI API endpoint reference |
| Available through | Alexandria |
| Category | Developer |
| Price | $0.00873 per call. |
| Returns | json |
| Runs | In the background |
| Setup | About 2 minutes, with a Spiral API key |

## Prompts to try with OpenAI API endpoint reference in dots

- Every week, use OpenAI API endpoint reference for POST /v1/responses and report differences in documented request parameters and response fields since the previous review.
- Every Monday at 9am: use OpenAI API endpoint reference to look this up and give me the result as a table.
- 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 dots

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

### Use the Spiral skill

1. **Send dots 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 Spiral's MCP server

1. **Create an API key**: In the console, open API keys and create a key for your dot. Copy it.

2. **Send your dot this message**: Your dot reads Spiral's skill and asks for your API key.

```text
set up https://spiral.ai/SKILL.md
```

3. **Give your dot the key**: When your dot asks for the key, add it where your dot keeps secrets, never in the chat itself.

### Use the Spiral CLI

1. **Install and sign in**: Installs the Spiral CLI, signs you in and adds its skill to your coding agents.

```bash
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.

```bash
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: dots finds OpenAI API endpoint reference on Spiral, shows the price and runs it.

Setup guide in the docs: https://spiral.ai/docs/quickstarts/dots

## OpenAI API endpoint reference tools and prices

- [OpenAI developer docs · Get api endpoint](https://spiral.ai/tools/alexandria/developers-openai-com/developer-docs/get_api_endpoint) (Alexandria): $0.00873 per call.

## Settings you can ask for

| Setting | Allowed values | Default | Description |
| --- | --- | --- | --- |
| url |  | — | Alternatively an API reference method page URL, e.g. https://developers.openai.com/api/reference/resources/responses/methods/create. Pattern: ^https?://. |
| endpoint |  | — | HTTP method and API path, e.g. POST /v1/responses, GET /v1/models/{model}, DELETE https://api.openai.com/v1/files/{file_id}. |
| include_examples |  | — | Include request and response examples (each capped at 4000 characters). Default false. |

## What can you do with OpenAI API endpoint reference in dots?

Maintain a weekly OpenAI documentation review for the models and API methods an application uses. An always-on agent can compare retrieved documentation with its previous report and flag changes in specifications, announcements, retirement notices, or billing categories.

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

## Overview

- [Alexandria](https://spiral.ai/providers/alexandria)
- [All dots guides](https://spiral.ai/integrations/dots)

## OpenAI API endpoint reference in other agents

- [Amp](https://spiral.ai/integrations/amp/openai-api-endpoint-reference)
- [ChatGPT](https://spiral.ai/integrations/chatgpt/openai-api-endpoint-reference)
- [Claude](https://spiral.ai/integrations/claude-desktop/openai-api-endpoint-reference)
- [Claude Code](https://spiral.ai/integrations/claude-code/openai-api-endpoint-reference)
- [Cline](https://spiral.ai/integrations/cline/openai-api-endpoint-reference)
- [Codex](https://spiral.ai/integrations/codex/openai-api-endpoint-reference)
- [Cursor](https://spiral.ai/integrations/cursor/openai-api-endpoint-reference)
- [Devin](https://spiral.ai/integrations/devin/openai-api-endpoint-reference)
- [Factory Droid](https://spiral.ai/integrations/factory-droid/openai-api-endpoint-reference)
- [Gemini](https://spiral.ai/integrations/gemini/openai-api-endpoint-reference)
- [Gemini CLI](https://spiral.ai/integrations/gemini-cli/openai-api-endpoint-reference)
- [Google Antigravity](https://spiral.ai/integrations/antigravity/openai-api-endpoint-reference)
- [goose](https://spiral.ai/integrations/goose/openai-api-endpoint-reference)
- [Grok](https://spiral.ai/integrations/grok/openai-api-endpoint-reference)
- [Grok Build](https://spiral.ai/integrations/grok-build/openai-api-endpoint-reference)
- [Hermes](https://spiral.ai/integrations/hermes/openai-api-endpoint-reference)
- [Instinct](https://spiral.ai/integrations/instinct/openai-api-endpoint-reference)
- [Manus](https://spiral.ai/integrations/manus/openai-api-endpoint-reference)
- [Muse](https://spiral.ai/integrations/muse/openai-api-endpoint-reference)
- [Muse Code](https://spiral.ai/integrations/muse-code/openai-api-endpoint-reference)
- [n8n](https://spiral.ai/integrations/n8n/openai-api-endpoint-reference)
- [Notion](https://spiral.ai/integrations/notion/openai-api-endpoint-reference)
- [OpenClaw](https://spiral.ai/integrations/openclaw/openai-api-endpoint-reference)
- [opencode](https://spiral.ai/integrations/opencode/openai-api-endpoint-reference)
- [Perplexity](https://spiral.ai/integrations/perplexity/openai-api-endpoint-reference)
- [Raycast](https://spiral.ai/integrations/raycast/openai-api-endpoint-reference)
- [VS Code](https://spiral.ai/integrations/vscode/openai-api-endpoint-reference)
- [Windsurf](https://spiral.ai/integrations/windsurf/openai-api-endpoint-reference)
- [Zapier](https://spiral.ai/integrations/zapier/openai-api-endpoint-reference)

## More dots guides

- [OpenAI API changelog](https://spiral.ai/integrations/dots/openai-api-changelog)
- [OpenAI documentation page](https://spiral.ai/integrations/dots/openai-documentation-page)
- [Ollama publisher model catalog](https://spiral.ai/integrations/dots/ollama-publisher-model-catalog)
- [OpenAI documentation search](https://spiral.ai/integrations/dots/openai-documentation-search)
- [Ollama official model catalog](https://spiral.ai/integrations/dots/ollama-official-model-catalog)
- [OpenAI model catalog](https://spiral.ai/integrations/dots/openai-model-catalog)

## Questions about OpenAI API endpoint reference in dots

**Can dots use OpenAI API endpoint reference?**

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

**How much does OpenAI API endpoint reference cost in dots?**

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

**Do I need an Alexandria account to use OpenAI API endpoint reference in dots?**

You need no Alexandria account. dots uses one Spiral API key for every tool, and Spiral runs OpenAI API endpoint reference on its own Alexandria account.

**How long does it take to set up OpenAI API endpoint reference in dots?**

About two minutes: create an API key, then send your dot this message, then give your dot the key.

**Does dots wait while OpenAI API endpoint reference runs?**

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

