Adds the text to the avatar speech queue.
If the avatar is already speaking, the text fragment is queued to be spoken at a later time.
Nothing is said until you connect or while you're disconnected.

Request Speech

Location

Message

Error Type

ValidationError

Body_append_text_api_v1_sessions__id__tasks_post

HTTPBearer

SessionSayResponse

HTTPValidationError

Create Speech Task

Avaturn.Live

Introduction

This guide provided a step-by-step approach to integrate API in your backend

Integration Guide

Example

Step-by-step approach to integrating Web SDK into your project

Overview of the demo, its purpose, functionality, and how it works.

General guidelines on how to integrate with LLMs

LLM integration

Initiates a session.

<Warning>
  Call this endpoint from your backend.
  You must not expose your API Key in your frontend code.
</Warning>

Upon successful creation, the API returns a session token that can be safely used in Web SDK.

There a few ways to process what user says and what avatar says.
It's configured via the conversation engine.
Currently, only text-based echo conversation engine is supported.
Reach out to us if you want to use OpenAI Realtime API-based engine.

Create Session

Terminates the session.
If the avatar is still talking, it kills the session anyway.

API Documentation

Endpoints

Request Speech

Authorizations

Path Parameters

Body

Response