Documentation
Introduction
Overview
Overview
AIVAX is an AI orchestration platform for building, operating, and evaluating AI applications through one account, API surface, and …
Getting Started
Getting Started
This guide takes you from an AIVAX account to a verified OpenAI-compatible chat completion. The example uses Python and a …
Authentication
Authentication
AIVAX authenticates API requests with account API keys. AIVAX accepts API keys via:
Authorization: Bearer <API_KEY> …
Pricing
Pricing
Service usage prices are listed below in USD. M means one million tokens; 1k means one thousand units. Approximate prices (~) vary …
Plans and Limits
Plans and Limits
AIVAX has three account plans: Free, Pro, and Max. The current plan is stored on the account and controls model access, …
Data Collecting
Data Collecting
AIVAX offers an optional semantic data collection program for accounts that choose to contribute eligible RAG and reranking …
Changelogs
Changelogs
Technical changes that affect AIVAX products, services, or the public API. Dates identify when entries were added or updated, not …
RAG and collections
Collections and Documents
Collections and Documents
AIVAX provides a RAG (Retrieval-Augmented Generation) service for storing documents and retrieving them later …
Media Injector
Media Injector
Media Injector turns a source file into focused, self-contained documents inside an AIVAX RAG collection. It examines the …
Semantic Search
Semantic Search
The semantic search API searches one or more collections and returns the most relevant indexed documents for the supplied …
Text Segmentation
Text Segmentation
Text segmentation divides source documents into semantically cohesive strings that can be embedded or indexed in a RAG …
Text Classification
Text Classification
Use text classification to rank a fixed set of labels for one or more documents without training a custom classifier. …
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 …
Best Practices for RAG
Best Practices for RAG
Use this guide when preparing documents for AIVAX collections and semantic search. The search pipeline indexes …
Filters
Inference
AI Gateway
AI Gateway
An AI Gateway stores a reusable inference configuration. Pass the gateway’s ID or slug in the request’s model field, …
Inference
Inference
AIVAX exposes an OpenAI-compatible chat/completions API with additional AIVAX parameters. The additions are optional and are …
Agentic Tests
Agentic Tests
Agentic Tests evaluates how an AI Gateway behaves across a complete, goal-oriented conversation instead of grading one …
Voice Session
Voice Session
Voice Session is AIVAX’s low-latency, stateful voice API. It keeps the authenticated AIVAX WebSocket endpoint while …
AI Pipelines
AI Pipelines
AI Gateway pipelines are the processing steps AIVAX applies before and during inference. They can add context, rewrite queries, …
Structured Responses
Structured Responses
AIVAX can produce structured JSON through two paths:
response_schema: AIVAX validates the final model output against a …
AI Workers
AI Workers
AI Gateway workers are HTTP hooks that let an external service control gateway execution at runtime. A worker can allow an event, …
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 …
Generations
Semantic decisions
Semantic decisions
Semantic decisions evaluate named questions against a shared state and return structured answers rather than a generated …
Speech Generation
Speech Generation
Use Speech Generation when your application already has final text and needs playable audio without running a chat …
Audio Transcriptions
Audio Transcriptions
Use Audio Transcriptions to convert recorded speech into text for search, review, captions, or downstream automation. …
Media Descriptions
Media Descriptions
Use Media Descriptions when an application needs structured information from audio, images, video, or PDF content. …
Teach Skill
Teach Skill
Use Teach Skill to turn recorded demonstrations into reusable, step-by-step skill instructions. Typical uses include capturing …
Image Generation
Image Generation
Use Image Generation to create images from a text prompt in an application workflow. Typical uses include draft …
Resources and features
Skills
Skills
Skills (also known as abilities) can be used to improve how your agent performs on specific tasks. Skills are special instructions …
Chat Clients
Chat Clients
A chat client provides a user interface via an AI Gateway that allows the user to converse with their assistant. A chat client …
Batch
Batch
Batch is AIVAX’s feature for running the same AI workflow over many independent items. It turns a list of inputs into a …
Tools
Built-in Tools
Built-in Tools
AIVAX provides a list of built-in tools for you to enable in your model. These tools can be used together with the …
Support for Model Context Protocol (MCP)
Support for Model Context Protocol (MCP)
You can bind external MCP protocol tools to your AI Gateway. The protocol defines tools that run on …
Protocol Functions
Protocol Functions
Protocol functions are AIVAX server-side tools. They let a model request a named action while AIVAX executes the action …
Shell
Shell
AIVAX offers a virtual shell environment that can be used by agent assistants to execute terminal commands during inference. This …
MCP Utilities
Collections MCP
Collections MCP
The Collections MCP exposes one or more AIVAX RAG collections as tools for compatible MCP clients. Use it when an external …
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 utilities MCP
Web utilities 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 exposes AIVAX image generation and speech generation (text-to-speech) to any MCP-compatible …
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 …