API reference
What the Vani API does, endpoint by endpoint
The quickstart and client guides are on the main docs page. These pages cover the parts of the API that go beyond a chat request.
Vani AI API overviewQuickstartGet an API key on the Vani API Platform
- OpenAI-compatible APIUse the Vani API with the official OpenAI SDKs and OpenAI-compatible tools: change the base URL, keep your code, and call many models with one key.
- Anthropic-compatible APIUse the Vani API with the Anthropic SDKs and Claude Code: point them at Vani and call any model in the catalogue through the Messages API with one key.
- Model ids, limits, headers and usageHow the Vani API names models, caps output, rate-limits requests and reports usage, including cached and reasoning tokens.
- Images and PDFs on the APISend screenshots, photos and PDFs to the Chat Completions, Responses and Messages endpoints: the fields, the limits, files by URL, which models can see, and billing.
- MCP tools on the APILet a model call tools on your own remote MCP servers from the Responses API (
mcptool) or the Messages API (mcp_servers). - Web search and web fetch toolsWeb search on Vani's API: the providers' web tools (Anthropic's web_search and web_fetch, OpenAI's web_search), :online model ids, the plugins web field, and Vani's search endpoints.
- Media API: images and videosGenerate and edit images and create video clips with the Vani API: models, sizes, multiple images per request, video jobs and their downloads.
- Artifacts APICreate, edit, version, convert, export and share documents, slides and designs with /v1/artifacts.
- Responses API: scope and limitsWhat the stateless Vani Responses API supports: messages, function and custom tools, MCP tools, structured output and streaming, and what it does not.
- Model changes: webhooks, feeds and the changes APIKnow when a model joins or leaves the Vani API: signed webhooks, RSS and JSON feeds of the changelog, and GET /v1/models/changes.