Skip to content
Ino AI PlatformDocs
Console

Documentation

Build with Ino AI Platform

Copy page
View as MarkdownThis page as plain textllms.txtEvery page, a line each, for agents

What the API does — speech, transcription, voices, images, video, skyboxes, templates and agents — and where to start.

Quickstart API reference

One HTTP API for speech, conversation and generative media. You call it from your own server with an API key, and your users’ apps talk to your agents with a short-lived key you mint for them.

curl
curl https://api.lumavox.ai/v1/tts \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello from the API."}' \
  --output hello.wav

New here? The quickstart takes you from a key to your first audio file and your first image.

What you can do

Section titled “What you can do”

Every capability answers in one of three shapes:

  • In the response: the result is the response body (or a stream of it).
  • Queued: the request answers 202 with a gen_… id straight away, and you poll until it finishes. See queued jobs.
  • WebSocket: an agent’s conversation, spoken and written as it is generated.
Capability Endpoints Shape
Text to speech POST /v1/tts audio in the response, or streamed as it is generated
Stored audio POST /v1/audio queued — mp3, opus or wav, kept in your library
Transcription POST /v1/stt, POST /v1/transcriptions text in the response for short audio; queued for long recordings
Voices /v1/voices list the voices you may use; upload or design your own
Images POST /v1/images queued
Video POST /v1/videos queued
Skyboxes POST /v1/skybox queued — a 360° environment
Templates POST /v1/templates/{template_id}/generate queued — a generation someone already designed
Agents /v1/agents, /v1/knowledge authored over HTTP
Conversations POST /v1/agent/sessions, then the WebSocket streamed text and speech
Library /v1/assets, /v1/generations everything you generated or uploaded
Credits and usage GET /v1/plan, GET /v1/usage your balance and what you spent

Three kinds of credential

Section titled “Three kinds of credential”
Credential Who holds it What it reaches
API key your server every endpoint its scopes allow — never the conversation routes
Ephemeral key one end user’s browser or app that end user’s conversations with your agents, up to a credit limit, until it expires
Console sign-in the people on your team the console at https://app.lumavox.ai, where you create keys, agents and voices

API keys are created in the console and stay on your server. Ephemeral keys are minted by your server, one end user at a time. Read authentication before you ship.

How these docs are built

Section titled “How these docs are built”
  • Every page is also plain Markdown: add .md to any page’s address.
  • For AI agents: start at /llms.txt, the index of every page with a line on each, or read docs for AI agents.
  • The full contract is the OpenAPI document at https://api.lumavox.ai/openapi.json, rendered in the API reference. From TypeScript, the SDKs are typed from it; from any other language, generate a client from it.

Where to go next

Section titled “Where to go next”
  • Quickstart — your first request in a few minutes.
  • Authentication — keys, scopes and ephemeral keys.
  • Conventions — how every endpoint writes times, credits and lists.
  • Errors and limits — what each status code means and what to do about it.
  • Queued jobs — how 202 and polling work, and when you are charged.
  • Agents — characters that hold a spoken conversation.