Documentation
Introduction
Welcome
Welcome
AIVAX is an AI orchestration platform for building, operating, and evaluating AI applications. It gives you one account, one API …
Authentication
Authentication
AIVAX authenticates API requests with account API keys. A login key is a separate credential and only opens the console. …
OAuth
OAuth
OAuth lets your application use a person’s AIVAX account for its AI features. Instead of building your own model access, billing …
CLI tool
CLI tool
The AIVAX CLI operates an AIVAX account from the terminal. It covers the same products as the API, including AI Gateways, RAG …
Pricing
Pricing
AIVAX charges usage to the account balance in USD. Each product documents its own rates in a dedicated pricing section, linked …
Plans and Limits
Plans and Limits
AIVAX has four account plans: Free, Pro, Max, and Ultimate. The current plan controls model access, account and product …
Data Sharing
Data Sharing
AIVAX offers an optional semantic data collection program for accounts that choose to contribute eligible RAG and reranking …
RAG and collections
Collections
Collections
AIVAX provides a RAG (Retrieval-Augmented Generation) service for storing knowledge and retrieving it later through semantic …
Documents
Documents
A document is the unit that AIVAX indexes and retrieves inside a collection. Each document stores text, an optional reference, …
Search
Search
Search returns indexed documents from one or more collections. Use managed search when AIVAX should store and search a persistent …
Advanced Filters
Advanced Filters
An advanced filter, also called a document filter, restricts a RAG search to the documents that match a condition, such as …
RAG Observability
RAG Observability
The AIVAX Console shows how your collections are indexed, which searches they receive, and how well those searches score. …
Rerankers
Rerankers
Rerankers reorder an existing set of candidate documents for a query. They do not search a collection or recover text that is …
Reflex
Reflex
Reflex is AIVAX’s collection-less search for RAG. Send a query together with candidate document strings and receive the most …
Inference
AI Gateway Concepts
AI Gateway concepts
An AI Gateway stores a reusable inference configuration. Pass the gateway’s ID or slug in the request’s …
Models and Gateway Names
Models and gateway names
The model field of /v1/chat/completions selects what runs the request. It accepts three kinds of value:
Value …
Using an AI Gateway
Using an AI Gateway
Create a gateway in the dashboard or with the API, then call it through the OpenAI-compatible chat/completions endpoint …
Using AI Gateways via SDKs
Using AI Gateways via SDKs
The inference endpoint follows the OpenAI chat completions shape, so existing OpenAI-compatible SDKs work by …
Taking an AI Gateway to Production
Taking an AI Gateway to production
Start with a conservative configuration: clear system instructions, a model that supports the required …
Inference Concepts
Inference concepts
AIVAX exposes an OpenAI-compatible chat/completions API with additional AIVAX parameters. The additions are optional and …
Server-side Context
Server-side context
chat/completions is stateless: each request carries the conversation it needs, and AIVAX does not keep a message history …
Session Reuse
Session reuse
Session reuse lets a stateless chat/completions client keep the server-side context of a conversation between requests. Your …
Inference with AI Gateways
Inference with AI Gateways
An AI Gateway pre-configures an inference. When model is a gateway ID or slug, the request you send is only part …
Processing Pipeline
Processing pipeline
When a request uses an AI Gateway, AIVAX runs a fixed sequence of steps before, during, and after each model generation. …
Input and Multimodality
Input and multimodality
Send the conversation in messages, using the OpenAI roles system, user, assistant, and tool. With an AI Gateway, the …
Caching
Caching
Several caches affect an inference request. Prompt caching lowers the cost of input the provider has already processed. Other caches …
Tools
Tools
Tools let the model request actions and data. AIVAX supports two execution models, and one request can use both:
Client-side tools …
MCP and Protocol Functions in Inference
MCP and protocol functions in inference
MCP tools and protocol functions are server-side tools that call your systems. AIVAX lists or loads …
Structured Output
Structured output
Use structured responses when your application needs JSON output that matches a schema. AIVAX supports them through …
On-demand Built-in Tools
On-demand built-in tools
Use builtin_tools to enable AIVAX built-in tools for a direct request without creating a gateway:
JSON
{ …
Streaming
Streaming
Set stream: true to receive the response as server-sent events (SSE) while it is generated. Each event is a data: line with a JSON …
Custom Provider Request Body
Custom provider request body
Use extra_body to send provider-specific options. When a gateway uses your own provider API key and an …
Multimodal Pre-processing
Multimodal pre-processing
Use multimodal_resolver when the main model should receive a textual description of media instead of the original …
Context Truncation
Context truncation
Context truncation keeps long conversations within a maximum input size. An AI Gateway can limit the input with …
Moderation
Moderation
Moderation enforces safety policy on user requests before the main model answers them. Use it to block unsafe or out-of-policy …
Function Interpreter (Deprecated)
Function interpreter (deprecated)
Deprecated. The function interpreter is kept only for existing gateways. Do not use it in new gateways. …
Inference Limits
Inference limits
This page lists the limits that apply to chat/completions requests. Account-wide request rates and plan limits are …
Troubleshooting Inference
Troubleshooting inference
AIVAX uses two response styles:
OpenAI-compatible endpoints return an OpenAI-style error object. Account and …
Setup Provider Routing
Setup provider routing
Some integrated models are available through more than one provider. Provider routing lets AIVAX choose among those …
Inline Routing
Inline routing in the model name
An integrated model name accepts a routing suffix after #. Use it when your client can only change the …
Zero Data Retention Providers
Zero data retention providers only
Enable Zero data retention providers only in the dashboard account settings to route text inference with …
Special Providers
Special providers
Some integrated models are also offered by special providers, which serve them at discounted prices under conditions that …
Structured Responses Concepts
Structured responses concepts
AIVAX can produce structured JSON through two paths:
response_schema: AIVAX validates the final model output …
JSON Healing
JSON Healing
JSON Healing is how AIVAX makes any model return JSON that matches a schema, including models without native structured output. …
Structured Responses with Reasoning and Tools
Reasoning and tools
A structured request can use a reasoning model and tools. The model reasons and calls tools as in any other request, and …
JSON-Only Responses
JSON-only responses
Set json_only: true when the client should receive only the generated JSON:
JSON
{ "model": …
Chat Presentation Guidance
Chat presentation guidance
A streamed assistant turn can contain reasoning, server-side tool activity, partial answers, and the final …
Raw Multi-turn Example
Raw multi-turn example
The example below shows the shape of a streamed response when server-side reasoning is visible to the client, …
Tool Explanations
Tool explanations
Use tool explanations when your client shows users why a server-side tool is running. The setting can also be stored on an …
Chat Clients Overview
Chat Clients Overview
A chat client publishes an AI Gateway to end users. It gives them a place to talk to the assistant—a hosted web chat, …
Managing Chat Client Sessions
Managing Chat Client Sessions
A session is one conversation between a chat client and an end user. It stores the message history, the …
Web Chat Client
Web Chat Client
The web client is the browser-facing side of a chat client. You can use it in two ways:
Hosted web chat: send the user to …
Chat Client Integrations
Chat Client Integrations
Integrations connect a chat client to messaging apps, so users can talk to the assistant where they already are. …
Subscription Models Overview
Subscription models
Subscription models are text models included in the Pro, Max, and Ultimate plans. Their names start with …
Harness Integration
Harness integration
Coding agents and other harnesses reach subscription models through the same [OI]-compatible Chat Completions API used …
Agentic Tests
Agentic Tests
Agentic Tests evaluate how an AI Gateway behaves across a complete, goal-oriented conversation instead of grading one isolated …
Voice and Realtime
Voice and Realtime
Voice Session is AIVAX’s low-latency, stateful voice API. Use it for a live spoken conversation. Your client opens …
Gateway Workers
Gateway Workers
Gateway Workers are HTTP hooks that let your service control an AI Gateway while a request is running. Use one when a rule …
Skills
Skills
Skills (also known as abilities) are instructions that your agent loads on demand to perform specific tasks better. Use them for …
Batch Processing
Batch Processing
Batch runs the same AI workflow over many independent items. It turns a list of inputs into a background queue with fixed …
Web Foundation
Web Search
Web Search
Web Search retrieves current information from the internet for research, fact checking, and answers that need sources beyond the …
Fetch and OCR
Fetch and OCR
Fetch and OCR extracts readable text from web pages and supported documents so applications and agents can use their content …
Media generation
Image Generation
Image Generation
Use Image Generation to create images from a text prompt in an application workflow. Typical uses include draft …
Text-to-Speech (TTS)
Text-to-Speech (TTS)
Use Speech Generation when your application already has final text and needs playable audio without running a chat …
Speech-to-Text (STT)
Speech-to-Text (STT)
Use Audio Transcriptions to convert recorded speech into text for search, review, captions, or downstream automation. …
Data processing
Media Descriptions
Media Descriptions
Use Media Descriptions when an application needs structured information from audio, images, video, or PDF content. …
Semantic Decisions
Semantic Decisions
Semantic decisions evaluate named questions against a shared state and return structured answers rather than a generated …
Text Classification
Text Classification
Use text classification to rank a fixed set of labels for one or more documents without training a custom classifier. It …
Text Segmentation
Text Segmentation
Text segmentation divides source documents into semantically cohesive strings that can be embedded or indexed in a RAG …
Extraction
Extraction
Use Extraction to turn text, images, and PDFs into JSON shaped by a schema you define. It fits invoices, receipts, forms, …
Summarization
Summarization
Use Summarization to condense text, images, and PDFs into short summaries, optionally guided by instructions about format, …
Translations
Translations
Use Translations to translate text, the visible text in images, and the speech in audio into any language. It fits product …
Instruction Refinement
Instruction Refinement
Use Instruction Refinement to review system instructions, prompts, and skills before you ship them to a model. The …
Tools
Built-in Tools
Built-in Tools
Built-in tools are capabilities maintained by AIVAX, such as web search, URL reading, code execution, memory, and file …
Support for Model Context Protocol (MCP)
Support for Model Context Protocol (MCP)
MCP binds external tools to an AI Gateway. Use it when the assistant must call live services …
Protocol Functions
Protocol Functions
Protocol functions are AIVAX server-side tools. The model requests a named action, and AIVAX executes it from the server …
Shell Sandboxing
Shell Sandboxing
AIVAX offers a virtual shell environment that can be used by agent assistants to execute terminal commands during …
MCP Utilities
Collections and RAG MCP
Collections and RAG MCP
The Collections MCP exposes one or more AIVAX RAG collections as tools for compatible MCP clients. Use it when an …
Documentation MCP
Documentation MCP
The AIVAX documentation MCP exposes AIVAX documentation, API reference content, and model metadata to MCP-compatible …
Account management MCP
Account management MCP
The account management MCP exposes selected AIVAX account operations to an MCP-compatible client, such as an IDE, …
Web Foundation MCP
Web Foundation MCP
The web utilities MCP exposes AIVAX web retrieval tools to any MCP-compatible client. Use it when an agent, IDE, desktop …
Media generation MCP
Media generation MCP
The media generation MCP gives an MCP client hosted image generation and speech generation (text-to-speech). Use it …
Inference MCP
Inference MCP
The Inference MCP exposes an AIVAX integrated model or AI Gateway as a tool for compatible MCP clients. Use it when another …
Legal documents
Privacy Policy
Privacy Policy
Revision: 1.4 Effective date: August 1, 2026 Previous update: July 20, 2026 Last updated: September 26, 2026
Welcome to …
Terms of Use
Terms of Use
Revision: 1.4 Effective date: August 1, 2026 Previous update: July 20, 2026 Last updated: September 26, 2026
Welcome to AIVAX. …
Data Processors
Data Processors
AIVAX uses third-party services for specific operations such as infrastructure, object storage, email delivery, payment …
Changelogs
Changelogs
Technical changes that affect AIVAX products, services, or the public API. Dates identify when entries were added or updated, not …
