Every operation the API publishes, generated from its OpenAPI document, so it describes what is deployed. The live document is https://api.lumavox.ai/openapi.json. From TypeScript, the server SDK is typed from it; from any other language, generate a client from it rather than writing one by hand.
Every operation but GET /health needs a credential — Authorization: Bearer <key>, or X-API-Key: <key> — see Authentication. Errors share one shape: see Errors and limits. To try a call in the browser with your own key, open Swagger at https://api.lumavox.ai/docs.
| Section | Operations | What it covers |
|---|---|---|
| Text to speech | 1 | Speech generation |
| Images | 2 | Image generation |
| Video | 2 | Video generation |
| Skyboxes | 3 | 360° environments — an 8K HDRI for lighting a 3D scene, an equirectangular PNG and a depth map. One flat price per generation, whatever you ask for |
| Templates | 4 | Generations somebody has already designed — the prompt, the size, every parameter — leaving only the media inputs for you to fill. Priced up front, and polled on the capability’s own endpoint |
| Stored audio | 2 | Speech as a queued generation — stored, and the only door that encodes mp3 or opus |
| Transcription | 3 | Speech to text — inline for short audio, stream=true for newline-delimited segments, queued for long |
| Voices | 9 | The voices a key may speak with, and — on voices:write — adding, designing, editing and deleting your own |
| Agents | 11 | Authoring agents: the characters /v1/agent/* talks to, their organisation-wide defaults, and what each may look up. Reads on agent, writes on agent:write |
| Knowledge | 15 | What you tell your agents — entries an agent can look up by meaning, written and assigned from your own systems |
| Tools | 8 | What your agents can call while they reply — your server, signed, or the person’s app over the WebSocket — each turned on per agent. Reads on agent, writes on agent:write |
| Conversations | 12 | Conversations with an agent. There is a streaming door too, on a WebSocket that OpenAPI cannot describe — see The WebSocket in the docs |
| Assets | 13 | The library — everything your services have produced and you have uploaded. Reads and uploads on assets; renaming, moving, deleting and folders on assets:write |
| Generations | 2 | Every generation across every capability, in one list — the way back to an id you lost, and the reconciliation loop |
| Usage | 2 | What your organisation has spent, and what it has left |
| End users | 9 | The people your agents talk to and you generate on behalf of |
| Ephemeral keys | 6 | Short-lived tokens for one end user’s device, with their own credit ceiling |
| System | 2 | Health and metadata |