--- title: Uncensored Chat description: url: http://uncensored.chat/docs/api canonical: https://uncensored.chat/docs/api component: docs/api generated_at: 2026-09-09T05:08:53.613832Z --- Toggle SidebarAPI Documentation [Discord](https://discord.gg/modelslab-1033301189254729748) [](/pricing)Sign UpLogin API Reference --- Complete reference for interacting with the Chat API Getting API access Uncensored Chat is free to use on the web. API access is part of a paid plan. Every account gets a free chat trial. The API bills real GPU time on top of that, so a key is only issued on the Developer plan. You can create a key from the dashboard once the plan is active. [See API pricing](/pricing) Chat CompletionsPOST Create a chat completion response for the given conversation ### Endpoint `POST https://uncensored.chat/api/v1/chat/completions` ### Headers `Authorization`Bearer YOUR\_API\_KEY `Content-Type`application/json ### Request Parameters `model`required string The model to use for completion: `uncensored-v3` (recommended) or `uncensored-v2`. This value selects which model answers — call `GET /models` for the current list. A name we don't recognise is served by `uncensored-v3` rather than rejected, so OpenAI-style clients that send their own model names keep working. `messages`required array Array of message objects. Each message has a "role" (user/assistant/system) and "content". `stream`optional boolean Whether to stream partial progress. Default: false `temperature`optional number Sampling temperature between 0 and 2. Higher values make output more random. `max_tokens`optional integer Maximum number of tokens to generate in the completion. ### Request Example ``` { "model": "uncensored-v3", "messages": [ { "role": "user", "content": "tell me a big story" } ], "stream": true, "temperature": 0.7, "max_tokens": 1000 } ``` ### Response Examples Normal ResponseStreaming Response ``` { "id": "chatcmpl-123", "object": "chat.completion", "created": 1728345600, "model": "uncensored-v3", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "Here's a big story for you..." }, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 10, "completion_tokens": 150, "total_tokens": 160 } } ``` ### Code Examples cURLPythonJavaScriptTypeScriptPHPGoRuby ``` curl -X POST https://uncensored.chat/api/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{ "model": "uncensored-v3", "messages": [ { "role": "user", "content": "tell me a big story" } ], "stream": true }' ``` List ModelsGET List the chat models that currently have a live pool ### Endpoint `GET https://uncensored.chat/api/v1/models` ### Headers `Authorization`Bearer YOUR\_API\_KEY ### Available Models `uncensored-v3`Strongest model. Long-form roleplay, reasoning, and images. `uncensored-v2`High-performance model for general conversation and reasoning. Only models with a live pool are returned, so read this endpoint rather than hard-coding the list. ### Response ``` { "object": "list", "data": [ { "id": "uncensored-v2", "object": "model", "created": 1728345600, "owned_by": "uncensored-chat" }, { "id": "uncensored-v3", "object": "model", "created": 1728345600, "owned_by": "uncensored-chat" } ] } ``` List Voice CharactersGET List characters available for voice calling ### Endpoint `GET https://uncensored.chat/api/v1/voice/characters` ### Headers `Authorization`Bearer YOUR\_API\_KEY ### Response Example ``` { "object": "list", "data": [ { "id": 1, "slug": "elon-musk", "name": "Elon Musk", "title": "CEO of Tesla & SpaceX", "thumbnail": "https://...", "first_message": "Hello there.", "voice_sample_url": "https://...", "voice_synced_at": "2024-01-01T00:00:00Z" } ] } ``` Start Voice CallPOST Start a real-time voice conversation with an AI character ### Endpoint `POST https://uncensored.chat/api/v1/voice/calls` ### Headers `Authorization`Bearer YOUR\_API\_KEY `Content-Type`application/json ### Request Parameters `character_slug`required string The slug of the voice-ready character to talk with. Get available slugs from the List Voice Characters endpoint. ### Request Example ``` { "character_slug": "elon-musk" } ``` ### Response Example ``` { "object": "voice.call", "chat_id": "550e8400-e29b-41d4-a716-446655440000", "ws_url": "wss://uncensored.chat/voice-ws?chat_id=...&exp=...&sig=...", "mode": "live", "minutes_remaining": 30, "character": { "slug": "elon-musk", "name": "Elon Musk", "thumbnail": "https://...", "first_message": "Hello there.", "voice_sample_url": "https://..." } } ``` ### Code Examples cURLPythonJavaScriptTypeScriptPHPGoRuby ``` curl -X POST https://uncensored.chat/api/v1/voice/calls \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{ "character_slug": "elon-musk" }' ``` WebSocket Protocol Real-time audio streaming protocol for voice calls ### Connection Flow 1. Call `POST /api/v1/voice/calls` to get a signed `ws_url` 2. Open a WebSocket connection to the `ws_url` 3. Stream PCM audio to the server and receive PCM audio back 4. Close the WebSocket when finished — usage is tracked automatically ### Connection URL `wss://uncensored.chat/voice-ws?chat_id=UUID&exp=TIMESTAMP&sig=HMAC` The `ws_url` from the start call response is pre-signed and expires after 10 minutes. ### Protobuf Framing All WebSocket messages use protobuf varint-length-prefixed framing. Each frame is a binary message with the following top-level structure: | Field | Number | Type | Description | |---|---|---|---| | text | 1 | bytes | Text frame (bot text output) | | audio | 2 | bytes | Audio frame (PCM data) | | transcription | 3 | bytes | Transcription frame (user speech) | | transport | 4 | bytes | Transport message (JSON events) | ### Audio Input (Client → Server) Send microphone audio as binary protobuf frames. Each audio message contains: | Field | Number | Type | Value | |---|---|---|---| | audio\_data | 3 | bytes | Raw PCM Int16 samples | | sample\_rate | 4 | int32 | 16000 Hz | | num\_channels | 5 | int32 | 1 (mono) | Recommended chunk size: 50ms frames (800 samples at 16kHz). ### Audio Output (Server → Client) Receive TTS audio as binary protobuf frames with the same structure, but at 24kHz: | Field | Number | Type | Value | |---|---|---|---| | audio\_data | 3 | bytes | Raw PCM Int16 samples | | sample\_rate | 4 | int32 | 24000 Hz | | num\_channels | 5 | int32 | 1 (mono) | ### Transport Messages Server sends JSON transport messages (field 4) with `label: "rtvi-ai"` and event data: `user-started-speaking`The user began speaking. Interrupt any playing bot audio. `user-stopped-speaking`The user finished speaking. The bot will start processing. `user-transcription`Final transcription of user speech. `data.text` contains the transcribed text. `bot-llm-started`The bot started generating a response. `bot-llm-text`Token-level streaming text. `data.text` contains the delta. `bot-llm-stopped`The bot finished generating text. TTS synthesis begins. `bot-started-speaking`The bot started speaking (audio frames incoming). `bot-stopped-speaking`The bot finished speaking. Commit the transcript. `bot-output`Sentence-level aggregation of what the bot will speak. `data.text` contains the sentence. `error`An error occurred. `data.error` contains the message. ### WebSocket Example (JavaScript) ``` // 1. Start the call via REST API const response = await fetch('https://uncensored.chat/api/v1/voice/calls', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' }, body: JSON.stringify({ character_slug: 'elon-musk' }) }); const { ws_url } = await response.json(); // 2. Connect to the WebSocket const ws = new WebSocket(ws_url); ws.binaryType = 'arraybuffer'; ws.addEventListener('open', () => { console.log('Voice call connected'); // Start sending microphone audio... }); ws.addEventListener('message', (event) => { if (event.data instanceof ArrayBuffer) { // Decode protobuf frame (audio or transport message) // See voice-call-client.ts for full decoder } }); ws.addEventListener('close', () => { console.log('Voice call ended'); }); ``` Response Codes HTTP status codes returned by the API 200 OK Request successful 400 Bad Request Invalid request parameters 401 Unauthorized Invalid or missing API key 429 Rate Limited Too many requests 500 Server Error Internal server error --- *This markdown version is optimized for AI agents and LLMs.* **Links:** - [Website](https://uncensored.chat) - [API Documentation](https://uncensored.chat/docs/api) - [Characters](https://uncensored.chat/characters) - [Pricing](https://uncensored.chat/pricing) --- *Generated by Uncensored Chat - 2026-09-09*