API reference

Quickstart

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

Base URL

The base URL for every request, the /v1 path rule, and request timeouts.

Authentication

Issuing API keys, the Bearer header, and per-key limits and scopes.

Model selection and access

Model IDs, capabilities, routing, and account or organization access policies.

POSTCreate a chat completion

/v1/chat/completions

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

POSTCreate a message

/v1/messages

Anthropic Messages compatible endpoint and free token counting.

POSTCreate a response

/v1/responses

Responses format, background jobs, and cancellation.

POSTGenerate images

/v1/images/generations

Image generation. n is at most 10.

POSTEdit an image

/v1/images/edits

Image editing (inpainting and outpainting). Supports both multipart and JSON (base64).

POSTGenerate a video

/v1/videos/generations

Video generation (billed per second). Submit, then fetch the result from the dedicated polling endpoint.

GETList models

/v1/models

List models and retrieve a single model. Slugs containing slashes are supported.

GETRetrieve an output

/v1/outputs/{requestId}

Retrieve a stored request and refresh its output URLs, valid for 10 minutes.

Streaming

Incremental tokens, SSE completion and errors, and final usage.

Prompt caching

Cache the repeated prefix to cut input cost — check the cost conditions before you turn it on.

Async jobs

Responses background jobs and video generation polling in one flow.

Web search

The model runs web searches — Google bills per search query; Z.AI bills per search-enabled request.

Claude Code / Anthropic SDK

anthropic-native integration via ANTHROPIC_BASE_URL.

Cursor

Connect by overriding the OpenAI Base URL.

opencode

Example openai-compatible provider configuration.

Continue, Cline, and other OpenAI-compatible tools

The shared pattern: provider=openai plus a base URL override.

Error format & rate limits

OpenAI-compatible error envelope, status code table, rate limit headers.

Compatibility features

Optional model name prefix, cost header, Idempotency-Key, per-endpoint limits.