> 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/interaction-apis.md).

# Interaction APIs

Enable real-time interaction with AI characters using Convai’s Interaction APIs for natural text and voice-based communication.

The **Interaction APIs** enable real-time, dynamic interaction between users and your AI characters.\
Once your characters are live, these APIs handle conversational input and contextual responses.

With these APIs, you can:

* **Engage in live conversations** — send user text or voice inputs and receive contextual, natural replies.
* **Retrieve responses in text and/or audio form**, enabling both text-based chat and voice dialogue modes.
* **Send and process audio input** (e.g., `.wav` mono files with supported sample rates) to enable real-time speech recognition.

The Interaction APIs bridge your characters and users, enabling seamless, responsive communication across both textual and voice channels.

{% content-ref url="/pages/NOI4Ph3RXtXVmdFcNVoU" %}
[Interaction API](/api-docs/api-reference/core-api-reference/interaction-apis/interaction-api.md)
{% endcontent-ref %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.