> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/api-reference/core-api-reference/live-apis-beta.md).

# Live APIs (Beta)

{% hint style="danger" %}
Live APIs are available only on the Enterprise Plan.
{% endhint %}

Convai’s **Live APIs** enable real-time, dynamic interaction between users and AI characters through **WebRTC**.\
These APIs allow your applications to send and receive **audio**, **text**, and other contextual data, making conversations with AI characters seamless and responsive.

Once your characters are created, the Live APIs manage conversational input and contextual responses automatically, ensuring natural and consistent behavior across sessions.

#### **With the Live APIs, you can:**

* **Engage in live conversations** — Send user text or voice inputs and receive contextual, natural replies in real time.
* **Retrieve responses in text and/or audio form** — Power both text-based chat and voice dialogue experiences.
* **Use realtime models** — Integrate with low-latency models (currently Google Realtime; OpenAI support coming soon) for high-speed conversational performance.

The **Live APIs** act as the bridge between your AI characters and users, enabling smooth, two-way communication across both **text** and **voice** channels — all in real time.

***

#### Where to start

| Page                                                                                                                                    | What it covers                                                                                                |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| [Connect API](/api-docs/api-reference/core-api-reference/live-apis-beta/connect-api.md)                                                 | Opening a session and every option you can configure on it                                                    |
| [Turn lifecycle and message ordering](/api-docs/api-reference/core-api-reference/live-apis-beta/turn-lifecycle-and-message-ordering.md) | How a bot turn is delivered, which ordering you can rely on, and field presence rules                         |
| [Response contract and parsing](/api-docs/api-reference/core-api-reference/live-apis-beta/response-contract-and-parsing.md)             | How speech, actions, and emotion are separated — and exactly what the server removes from the spoken response |
| [Message Glossary](/api-docs/api-reference/core-api-reference/live-apis-beta/message-glossary.md)                                       | Every message type at a glance                                                                                |
| [Client-to-server messages](/api-docs/api-reference/core-api-reference/live-apis-beta/client-to-server-messages.md)                     | Messages you send                                                                                             |
| [Server-to-client messages](/api-docs/api-reference/core-api-reference/live-apis-beta/server-to-client-messages.md)                     | Messages you receive                                                                                          |
| [Audio Data (via data channel)](/api-docs/api-reference/core-api-reference/live-apis-beta/audio-data-via-data-channel.md)               | Custom audio handling                                                                                         |
| [Metrics](/api-docs/api-reference/core-api-reference/live-apis-beta/metrics.md)                                                         | Performance metrics and monitoring                                                                            |

{% hint style="info" %}
If you are writing a client from scratch, read [Turn lifecycle and message ordering](/api-docs/api-reference/core-api-reference/live-apis-beta/turn-lifecycle-and-message-ordering.md) first. It explains the three envelope shapes on the data channel and the ordering guarantees, which together account for most integration issues.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/api-reference/core-api-reference/live-apis-beta.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.