API reference

Quickstart

Send your first request with curl, Python, or Node.js.

Base URL

The base URL for each client, timeouts, and request size limits.

Authentication

API keys, auth headers, and per-key limits and scopes.

Model selection and access

Model IDs, capabilities, parameter policy, and account or organization access settings.

POSTCreate a chat completion

/v1/chat/completions

OpenAI-compatible chat completions with streaming, tool calls, and structured outputs.

POSTCreate a message

/v1/messages

Anthropic Messages-compatible endpoint, plus free token counting.

POSTCreate a response

/v1/responses

Responses format, background jobs, and cancellation.

POSTGenerate images

/v1/images/generations

Generate images from a prompt. Up to 10 per request.

POSTEdit an image

/v1/images/edits

Edit images with a prompt and optional mask. Send multipart or JSON (base64).

POSTGenerate a video

/v1/videos/generations

Generate video, billed per second. Submit a job, then poll for the result.

GETList models

/v1/models

List models or get one model. Model IDs with slashes are supported.

GETRetrieve an output

/v1/outputs/{requestId}

Get a stored request and new output URLs, valid for 10 minutes.

Streaming

Show the answer as it is generated instead of waiting for the full response.

Prompt caching

Cache the prefix you send on every request to cut input cost. Check the math first.

Async jobs

Submit long-running work, then fetch the result with the job ID.

Web search

Let the model search the web for current information. Covers search billing and citations.

Claude Code / Anthropic SDK

Connect Claude Code and the Anthropic SDK to everyais, with a settings.json built from the models you pick.

Cursor

Change the OpenAI base URL to use everyais models in Cursor chat and agent.

opencode

Register every everyais model in opencode with one command, or set it up yourself in opencode.json.

Continue

Add everyais models to Continue's config.yaml, with every model you pick registered.

Cline

Connect everyais through Cline's OpenAI Compatible provider. Plan and Act can use different models.

Other OpenAI-compatible tools

Connect Zed, Aider, and tools built on the OpenAI SDK.

Errors and retries

Error format, what to do for each status code, rate limits, and safe retries.

Compatibility features

Shorter model names, per-request cost, safe retries, and per-endpoint limits.