> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voiceos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# VoiceOS API

> Build voice products with Context Aware ASR.

VoiceOS API turns speech into polished, context-aware text. Unlike a plain ASR endpoint, VoiceOS accepts both audio and a chat-style message stack, then uses that context to recognize rare terms and correct likely transcription misses.

<CardGroup cols={2}>
  <Card title="Context Aware ASR" icon="sparkles" href="/concepts/context-aware-asr">
    Send conversation context with audio so the API understands product names, files, identifiers, and domain language.
  </Card>

  <Card title="Chat-style request shape" icon="code" href="/api-reference/transcriptions">
    Use multipart uploads with `file`, optional `messages`, `languages`, and optional `dictionary`.
  </Card>
</CardGroup>

## What you can build

* Voice agents that understand the active conversation.
* Developer tools that recognize filenames, symbols, and code identifiers.
* Meeting or support transcription with product-specific dictionary terms.
* Dictation experiences that return clean, polished text instead of raw ASR.

## Current status

The current implementation is a local developer prototype:

* Endpoint: `POST /v1/audio/transcriptions`
* Base URL: `https://beta.api.voiceos.com`
* Auth: none in non-production local development
* Production API keys, billing, rate limits, and public deployment are not enabled yet

<Note>
  The public API contract is intentionally designed to look familiar to developers using chat-style message arrays, while preserving VoiceOS-specific context-aware ASR behavior.
</Note>

## Minimal example

```bash theme={null}
curl https://beta.api.voiceos.com/v1/audio/transcriptions \
  -F "file=@sample.mp3" \
  -F 'messages=[{"role":"system","content":"You are in a TypeScript codebase."},{"role":"user","content":"The file is SessionStreamService.ts and the env var is VOICEOS_TEAM_API_KEY."}]' \
  -F 'languages="en"' \
  -F 'response_format=json'
```

```json theme={null}
{
  "text": "Please open SessionStreamService.ts and update the VOICEOS_TEAM_API_KEY."
}
```