# Kheelona Voice

> Talk to Kheelona voices from a web page or from your own server. Voice conversations for toys and apps, in 11 languages (four supported, five beta, two alpha).

Every page below is Markdown. The whole documentation is one file: [llms-full.txt](https://docs.voice.kheelona.com/llms-full.txt).

## Overview

- [Kheelona Voice](https://docs.voice.kheelona.com/index.md): Talk to Kheelona voices from a web page or from your own server. Voice conversations for toys and apps, in 11 languages (four supported, five beta, two alpha).

## Get started

- [Quickstart for servers](https://docs.voice.kheelona.com/get-started/quickstart-server.md): Run the example relay against Kheelona Voice in a few minutes, first with typed text, then with your own recording.
- [Quickstart for browsers](https://docs.voice.kheelona.com/get-started/quickstart-browser.md): Talk to a Kheelona voice from a web page in about 10 minutes, with the example page and its small backend.

## Concepts

- [Sessions and client secrets](https://docs.voice.kheelona.com/concepts/sessions.md): What a session is, how a one-time client secret reaches the client, and how a session ends.
- [Languages](https://docs.voice.kheelona.com/concepts/languages.md): Choose the languages of a session, what the default is, and what beta and alpha mean.
- [Limits, capacity and busy](https://docs.voice.kheelona.com/concepts/limits.md): The limits on sessions, audio and API calls, and what to do when Kheelona is busy.
- [Voices and versions](https://docs.voice.kheelona.com/concepts/voices.md): What a Kheelona voice is, where to find the voices you can use, and why a session always keeps one version.
- [Turn-taking](https://docs.voice.kheelona.com/concepts/turn-taking.md): How the voice knows when the person has started and stopped talking, what happens when they carry on or interrupt, and the order of events.
- [Safety levels](https://docs.voice.kheelona.com/concepts/safety-levels.md): The two safety levels, what is checked at each, what the safety event tells you, and what a child hears when a check acts.
- [Live text events](https://docs.voice.kheelona.com/concepts/live-text.md): The events that carry what was said, as text, while the conversation runs, and what Kheelona does and does not keep.
- [Latency](https://docs.voice.kheelona.com/concepts/latency.md): How quickly the voice answers, how it is measured, what changes it, and how to measure it in your own page.

## Guides

- [Server-to-server](https://docs.voice.kheelona.com/guides/server-to-server.md): Connect a toy relay or a backend to a Kheelona voice over a WebSocket, send microphone audio and play the reply.
- [Browser SDK](https://docs.voice.kheelona.com/guides/browser-sdk.md): Connect a web page to a Kheelona voice. Options, transports, events, controls, security policy and errors.
- [Errors and retries](https://docs.voice.kheelona.com/guides/errors-and-retries.md): Every error code, whether it ends the session, and what to do. How to retry without making things worse.
- [Interruptions and echo](https://docs.voice.kheelona.com/guides/interruptions-and-echo.md): How a person can talk over the voice, what your client has to do when it happens, and why every device must cancel echo.
- [Captions](https://docs.voice.kheelona.com/guides/captions.md): Show what the person said and what the voice says, as it happens. What the text is, and what to do with it.
- [Security](https://docs.voice.kheelona.com/guides/security.md): How to keep your API key safe, who may start a session, which pages may connect, and a Content Security Policy for your page.
- [Going live](https://docs.voice.kheelona.com/guides/going-live.md): A checklist to work through before real users reach your integration, and what to know about the missing sandbox.

## Reference

- [REST API](https://docs.voice.kheelona.com/reference/generated/api.md): The /v1 REST API: base URL, authentication, scopes and every operation.
- [The partner's connection log, newest first](https://docs.voice.kheelona.com/reference/generated/api/listsessions.md): GET /v1/sessions: The partner's connection log, newest first.
- [Creates a session](https://docs.voice.kheelona.com/reference/generated/api/createsession.md): POST /v1/sessions: Creates a session.
- [One of the partner's sessions](https://docs.voice.kheelona.com/reference/generated/api/getsession.md): GET /v1/sessions/{id}: One of the partner's sessions.
- [Ends a live session (reason `partner_ended`; the live connection closes within 10 s) or cancels a reserved one. Ending
a finished session is a no-op](https://docs.voice.kheelona.com/reference/generated/api/endsession.md): POST /v1/sessions/{id}/end: Ends a live session (reason `partner_ended`; the live connection closes within 10 s) or cancels a reserved one. Ending
a finished session is a no-op.
- [The voices enabled for this partner](https://docs.voice.kheelona.com/reference/generated/api/listvoices.md): GET /v1/voices: The voices enabled for this partner.
- [One voice](https://docs.voice.kheelona.com/reference/generated/api/getvoice.md): GET /v1/voices/{id}: One voice.
- [The supported languages](https://docs.voice.kheelona.com/reference/generated/api/listlanguages.md): GET /v1/languages: The supported languages.
- [Usage for the key's partner](https://docs.voice.kheelona.com/reference/generated/api/getusage.md): GET /v1/usage: Usage for the key's partner.
- [The service's health](https://docs.voice.kheelona.com/reference/generated/api/gethealth.md): GET /v1/health: The service's health.
- [Client events](https://docs.voice.kheelona.com/reference/generated/events/client.md): Client events: sent by the client to Kheelona Voice.
- [Server events](https://docs.voice.kheelona.com/reference/generated/events/server.md): Server events: sent by Kheelona Voice to the client.
- [Errors](https://docs.voice.kheelona.com/reference/generated/errors.md): Every error code, what it means and where it occurs.
- [Audio formats](https://docs.voice.kheelona.com/reference/generated/audio.md): The audio formats and the binary frame layouts of the realtime connection.
- [Supported languages](https://docs.voice.kheelona.com/reference/languages.md): The languages a session can declare, and which of them are supported, beta or alpha.
- [KheelonaVoice](https://docs.voice.kheelona.com/reference/sdk/classes/kheelonavoice.md)
- [KheelonaVoiceError](https://docs.voice.kheelona.com/reference/sdk/classes/kheelonavoiceerror.md)
- [ConnectOptions](https://docs.voice.kheelona.com/reference/sdk/interfaces/connectoptions.md)
- [SessionErrorInfo](https://docs.voice.kheelona.com/reference/sdk/interfaces/sessionerrorinfo.md)
- [SessionEvents](https://docs.voice.kheelona.com/reference/sdk/interfaces/sessionevents.md)
- [SessionReadyEvent](https://docs.voice.kheelona.com/reference/sdk/interfaces/sessionreadyevent.md)
- [VoiceSession](https://docs.voice.kheelona.com/reference/sdk/interfaces/voicesession.md)
- [ClientEvent](https://docs.voice.kheelona.com/reference/sdk/type-aliases/clientevent.md)
- [Emotion](https://docs.voice.kheelona.com/reference/sdk/type-aliases/emotion.md)
- [ErrorCode](https://docs.voice.kheelona.com/reference/sdk/type-aliases/errorcode.md)
- [LanguageStage](https://docs.voice.kheelona.com/reference/sdk/type-aliases/languagestage.md)
- [SdkErrorCode](https://docs.voice.kheelona.com/reference/sdk/type-aliases/sdkerrorcode.md)
- [ServerEvent](https://docs.voice.kheelona.com/reference/sdk/type-aliases/serverevent.md)
- [SessionState](https://docs.voice.kheelona.com/reference/sdk/type-aliases/sessionstate.md)
- [ERROR_CODES](https://docs.voice.kheelona.com/reference/sdk/variables/error_codes.md)

## Policies

- [Data and privacy](https://docs.voice.kheelona.com/policies/data-and-privacy.md): What Kheelona Voice keeps and what it never keeps, how long, where it is processed, and what you are responsible for.
- [Acceptable use](https://docs.voice.kheelona.com/policies/acceptable-use.md): What you may and may not do with Kheelona Voice. These rules protect the children who talk to the voices.
- [Versioning](https://docs.voice.kheelona.com/policies/versioning.md): How the API and the realtime protocol change, and what Kheelona promises not to break.
- [Changelog](https://docs.voice.kheelona.com/policies/changelog.md): What changed in Kheelona Voice, newest first.
- [Credits](https://docs.voice.kheelona.com/policies/credits.md): The open-source tools this documentation site is built with, the data it credits, and their licences.

## Examples

- [Node server example](https://docs.voice.kheelona.com/examples/node-server.md): A Node mint route and a server-to-server relay, with every file and how to run them.
- [Python server example](https://docs.voice.kheelona.com/examples/python-server.md): A Python mint route and a server-to-server relay, with every file and how to run them.
- [Browser example](https://docs.voice.kheelona.com/examples/browser-basic.md): A web page that talks to a voice with the browser SDK, and the small backend that creates its session. Every file, and how to run it.
- [curl example](https://docs.voice.kheelona.com/examples/curl.md): Create a session with one curl command. The script, the settings and what the answer holds.

## Reference

- [@kheelona/voice](https://docs.voice.kheelona.com/reference/sdk/readme.md)