# Quantum AI API
> Unified AI gateway — one API key, 10 providers, every model.
- Base URL: https://api.quantumencoding.ai
- OpenAPI spec: https://api.quantumencoding.ai/openapi.yaml
- Docs: https://api.quantumencoding.ai/docs
- SDKs: TypeScript (npm), Python (PyPI), Go (pkg.go.dev), Rust (crates.io), Swift (SPM), Kotlin (Maven)
- Status: Production
---

# Authentication
API Key (preferred): `X-API-Key: qai_YOUR_KEY`
Bearer token: `Authorization: Bearer qai_YOUR_KEY`
Session tokens from OAuth: `Authorization: Bearer qai_xxx`
Ephemeral tokens: `Authorization: Bearer qai_eph_xxx`

Response headers: `X-QAI-Request-Id`, `X-QAI-Cost-Ticks`, `X-QAI-Model`

---

# Provider Routing
The `model` field determines the provider:
| Prefix | Provider |
|--------|----------|
| `claude-*` | Anthropic |
| `grok-*` | xAI |
| `gpt-*`, `o1*`, `o3*`, `o4*` | OpenAI |
| `tts-*`, `whisper*`, `dall-e*`, `gpt-image*`, `sora*` | OpenAI (media) |
| `text-embedding*` | OpenAI (embeddings) |
| `gemini-*`, `lyria*` | Google Gemini |
| `imagen-*`, `veo-*` | Google Vertex AI |
| `deepseek-*` | DeepSeek |
| `eleven_*`, `scribe*` | ElevenLabs |
| `meshy*` | Meshy (3D) |
| `heygen*` | HeyGen (video) |
| `glm-*` | Zhipu AI |

---

# Endpoints

## Account
- GET /qai/v1/account/balance — Account Balance
- GET /qai/v1/account/service/usage — Service Usage By Ref
- GET /qai/v1/account/usage — Account Usage
- GET /qai/v1/account/usage/summary — Account Usage Summary

## Agent
- POST /qai/v1/agent — Agent
- POST /qai/v1/missions — Mission

## Audio
- POST /qai/v1/audio/align — Force Align
- POST /qai/v1/audio/dialogue — Dialogue
- POST /qai/v1/audio/dub — Dub
- GET /qai/v1/audio/finetunes — List Finetunes
- POST /qai/v1/audio/finetunes — Create Finetune
- DELETE /qai/v1/audio/finetunes/{id} — Delete Finetune
- POST /qai/v1/audio/isolate — Isolate Voice
- POST /qai/v1/audio/music — Music Generate
- POST /qai/v1/audio/music/advanced — Music Advanced
- POST /qai/v1/audio/remix — Remix Voice
- POST /qai/v1/audio/sound-effects — Sound Effects
- POST /qai/v1/audio/speech-to-speech — Speech To Speech
- POST /qai/v1/audio/starfish-tts — Starfish T T S
- POST /qai/v1/audio/stt — S T T
- POST /qai/v1/audio/tts — T T S
- POST /qai/v1/audio/voice-design — Voice Design

## Auth
- POST /qai/v1/auth/apple — Auth Apple
- POST /qai/v1/auth/google — Auth Google

## Batch
- POST /qai/v1/batch — User Batch Submit
- GET /qai/v1/batch/jobs — User Batch Jobs
- GET /qai/v1/batch/jobs/{id} — User Batch Result
- POST /qai/v1/batch/jsonl — User Batch J S O N L

## Chat
- POST /qai/v1/chat — Chat
- POST /qai/v1/chat/session — Session Chat

## Compute
- GET /qai/v1/compute/catalog — Catalog
- POST /qai/v1/compute/deploy-model — Deploy Model
- GET /qai/v1/compute/deployments — Deployment List
- GET /qai/v1/compute/deployments/{id} — Deployment Get
- DELETE /qai/v1/compute/deployments/{id} — Deployment Delete
- POST /qai/v1/compute/deployments/{id}/extend — Deployment Extend
- GET /qai/v1/compute/instance/{id} — Compute Instance
- DELETE /qai/v1/compute/instance/{id} — Compute Delete
- POST /qai/v1/compute/instance/{id}/keepalive — Compute Keepalive
- POST /qai/v1/compute/instance/{id}/ssh-key — Compute S S H Key
- GET /qai/v1/compute/instances — Compute Instances
- POST /qai/v1/compute/provision — Compute Provision
- GET /qai/v1/compute/templates — Compute Templates

## Contact
- POST /qai/v1/contact — Contact

## Credits
- GET /qai/v1/credits/balance — Credit Balance
- POST /qai/v1/credits/dev-program — Dev Program Apply
- GET /qai/v1/credits/lifetime — Lifetime Plans
- POST /qai/v1/credits/lifetime — Lifetime Purchase
- GET /qai/v1/credits/packs — Credit Packs
- POST /qai/v1/credits/purchase — Credit Purchase
- GET /qai/v1/credits/tiers — Dev Tiers

## Documents
- POST /qai/v1/documents/chunk — Document Chunk
- POST /qai/v1/documents/extract — Document Extract
- POST /qai/v1/documents/process — Document Process

## Embeddings
- POST /qai/v1/embeddings — Embeddings

## Images
- POST /qai/v1/images/edit — Image Edit
- POST /qai/v1/images/generate — Image Generate

## Jobs
- GET /qai/v1/jobs — Job List
- POST /qai/v1/jobs — Job Create
- GET /qai/v1/jobs/{id} — Job Status
- GET /qai/v1/jobs/{id}/stream — Job Stream

## Keys
- GET /qai/v1/keys — List A P I Keys
- POST /qai/v1/keys — Create A P I Key
- POST /qai/v1/keys/ephemeral — Create Ephemeral Key
- DELETE /qai/v1/keys/{id} — Revoke A P I Key

## Models
- GET /qai/v1/models — Models
- GET /qai/v1/pricing — Pricing

## Other
- GET /admin/audit — Admin Audit
- GET /admin/batch/jobs — Batch List
- POST /admin/batch/jobs — Batch Add
- POST /admin/batch/jobs/{id}/cancel — Batch Cancel
- POST /admin/batch/load — Batch Load J S O N L
- POST /admin/batch/run-next — Batch Run Next
- GET /admin/batch/stats — Batch Stats
- GET /admin/compute — Admin Compute
- GET /admin/dev-applications — Admin Dev Applications
- GET /admin/keys — Admin Keys
- DELETE /admin/keys/{id} — Admin Revoke Key
- GET /admin/requests/errors — Admin Errors
- GET /admin/requests/recent — Admin Recent Requests
- GET /admin/stats/overview — Admin Stats Overview
- GET /admin/stats/usage/daily — Admin Usage Daily
- GET /admin/stats/usage/endpoints — Admin Usage By Endpoint
- GET /admin/stats/usage/models — Admin Usage By Model
- GET /admin/stats/usage/providers — Admin Usage By Provider
- GET /admin/stats/usage/providers/daily — Admin Usage By Provider Daily
- GET /admin/stats/usage/top-users — Admin Usage Top Users
- GET /admin/system/health — Admin System Health
- GET /admin/users — Admin Users
- GET /admin/users/{id} — Admin User Detail
- POST /admin/users/{id}/ban — Admin User Ban
- POST /admin/users/{id}/credits — Admin User Credits
- POST /admin/users/{id}/freeze — Admin User Freeze
- POST /admin/users/{id}/tier — Admin Set Tier
- GET /docs — Docs
- GET /health — Health
- POST /internal/compute/check-teardown — Compute Check Teardown
- POST /internal/deployments/poll — Deployment Poll
- POST /internal/deployments/teardown — Deployment Teardown
- POST /internal/process-job — Process Job
- GET /llms.txt — L L Ms Txt
- GET /openapi.yaml — Open A P I
- POST /qai/v1/inference/{id} — Inference
- POST /qai/v1/workers/heartbeat — Worker Heartbeat
- POST /qai/v1/workers/jobs/{id}/result — Worker Result
- GET /qai/v1/workers/pull — Worker Pull
- GET /ready — Health
- GET /reference — Docs

## RAG
- GET /qai/v1/rag/collections — R A G Collections List
- POST /qai/v1/rag/collections — R A G Collections Create
- POST /qai/v1/rag/collections/search — R A G Collections Search
- GET /qai/v1/rag/collections/{id} — R A G Collections Get
- DELETE /qai/v1/rag/collections/{id} — R A G Collections Delete
- POST /qai/v1/rag/collections/{id}/upload — R A G Collections Upload
- GET /qai/v1/rag/corpora — R A G Corpora
- POST /qai/v1/rag/search — R A G Search
- GET /qai/v1/rag/surreal/providers — Surreal R A G Providers
- POST /qai/v1/rag/surreal/search — Surreal R A G Search

## Realtime
- POST /qai/v1/realtime/end — Realtime End
- POST /qai/v1/realtime/refresh — Realtime Refresh
- POST /qai/v1/realtime/session — Realtime Session

## Scanner
- POST /qai/v1/scanner/diff — Scanner Diff
- POST /qai/v1/scanner/query — Scanner Query
- POST /qai/v1/scanner/scan — Scanner Scan
- GET /qai/v1/scanner/scans — Scanner List
- GET /qai/v1/scanner/scans/{id} — Scanner Get
- DELETE /qai/v1/scanner/scans/{id} — Scanner Delete
- GET /qai/v1/scanner/scans/{id}/graph.svg — Scanner Graph S V G
- GET /qai/v1/scanner/scans/{id}/types — Scanner Type List
- GET /qai/v1/scanner/scans/{id}/types/{name} — Scanner Type Query
- POST /qai/v1/scanner/upload — Scanner Upload
- POST /qai/v1/scanner/verify — Scanner Verify

## Scraper
- POST /qai/v1/scraper/scrape — Scraper Scrape
- POST /qai/v1/scraper/screenshot — Scraper Screenshot

## Search
- POST /qai/v1/search/answer — Search Answer
- POST /qai/v1/search/context — L L M Context
- POST /qai/v1/search/web — Web Search

## Twilio
- POST /qai/v1/twilio/status — Twilio Status
- POST /qai/v1/twilio/voice — Twilio Voice

## Video
- GET /qai/v1/video/avatars — Hey Gen Avatars
- POST /qai/v1/video/digital-twin — Digital Twin
- POST /qai/v1/video/generate — Video Generate
- GET /qai/v1/video/heygen-voices — Hey Gen Voices
- POST /qai/v1/video/photo-avatar — Photo Avatar
- POST /qai/v1/video/studio — Studio Video
- GET /qai/v1/video/templates — Hey Gen Templates
- POST /qai/v1/video/translate — Video Translate

## Voices
- GET /qai/v1/voices — List Voices
- POST /qai/v1/voices/clone — Clone Voice
- GET /qai/v1/voices/library — Shared Voices
- POST /qai/v1/voices/library/add — Add Shared Voice
- DELETE /qai/v1/voices/{id} — Delete Voice

## Webhooks
- POST /qai/v1/webhooks/stripe — Stripe Webhook

---

# Billing
- 1 USD = 10,000,000,000 ticks
- Tiers: Standard (25% markup), Developer (12.5%), Enterprise (5%)
- Batch processing: 50% off standard pricing
- Cost returned in X-QAI-Cost-Ticks header and response body
- Credits purchased via Stripe: GET /qai/v1/credits/packs, POST /qai/v1/credits/purchase

# Errors
All errors: `{"error": {"message": "...", "type": "invalid_request"}}`
Types: invalid_request (400), authentication_error (401), provider_error (502), not_found (404), internal_error (500)