Resources · API Reference
API Reference
Complete reference for every OpenQCore endpoint, grouped by runtime surface and execution layer.
API Catalog
A fast execution-oriented index. Detailed technical behavior lives in each dedicated API page.
Authentication
POST /auth/loginPOST /auth/refreshAuthentication, API keys, scope management, and access control.
[View Authentication Docs]API Keys
POST /api-keysGET /api-keysPOST /api-keys/{key_id}/revokePOST /api-keys/{key_id}/disableCreate, list, revoke, and disable personal API keys used for non-interactive authentication.
View API Keys Reference →Chat Runtime
GET /chat/healthPOST /chat/completionsCore conversational execution, streaming, persistence, and runtime controls.
[View Chat API]Chat Sessions & Messages
POST /sessionsGET /sessionsGET /sessions/{session_id}/messagesPATCH /sessions/{session_id}DELETE /sessions/{session_id}GET /messages/{message_id}PATCH /messages/{message_id}GET /messages/{message_id}/historyPOST /messages/{message_id}/undoDELETE /messages/{message_id}Create, list, rename, pin/star, and delete chat sessions; edit a message with tracked history, undo the last edit, or delete a message.
View Sessions & Messages API →Voice Runtime
POST /voice/chatPOST /voice/chat/metaPOST /voice/interrupt/{session_id}WS /voice/wsRealtime STT, LLM, TTS, interruption handling, and streaming audio.
[View Voice API]Iris Multimodal
POST /iris/generatePOST /iris/videoPOST /iris/ocrPOST /iris/verifyImage, video, OCR, and multimodal workflows.
[View Iris API]Knowledge
GET /console/knowledgePOST /console/knowledgePOST /console/knowledge/uploadPOST /console/knowledge/askPATCH /console/knowledge/{id}DELETE /console/knowledge/{id}Knowledge ingestion, retrieval, and retrieval-augmented execution.
[View Knowledge API]Archive
POST /archive/unitsGET /archive/unitsGET /archive/units/{unit_id}PATCH /archive/units/{unit_id}DELETE /archive/units/{unit_id}Create, list, retrieve, update, and delete archived knowledge units scoped to a user or workspace.
View Archive API →Runtime Headers
Quick reference for required headers across runtime surfaces.
| Header | Required |
|---|---|
Authorization | ✅ |
X-API-Key | Alternative to Authorization |
X-Scope-Type | ✅ |
X-Workspace-ID | Workspace Only |
X-Agent-ID | Optional |
Response Codes
Common operational response classes.
| Code | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 409 | Lock Conflict |
| 422 | Validation Error |
| 429 | Rate Limited |
| 503 | Overloaded |
Platform Statistics
A high-level operational snapshot.
37
Endpoints
4
Runtime Surfaces
8
Provider Integrations
Unified
Output Contract
Dual
Streaming + Non-Streaming