Documentation

CiviX API documentation

Everything you need to call the CiviX Inference API: authentication, streaming, models, and the error contract.

Start with the quickstartDeveloper overview

Get started

Quickstart

Make your first Civix API call in under five minutes.

Authentication

Bearer keys, how to get one, and how to keep it safe.

Models

What is available, and how to discover it programmatically.

API reference

Chat Completions

POST /v1/chat/completions — parameters, responses, and multimodal input.

Streaming

Server-sent events, keepalive comments, and why long prompts should stream.

Errors

A single error shape, stable machine-readable codes, and what to retry.

Rate limits & capacity

Why you might get a 429, and how to behave when you do.

Reference

OpenAI compatibility

What works with the OpenAI SDKs, and where we differ.

Versioning

What /v1 guarantees, and what may change without a new version.