body {
    /* font-family: Arial, sans-serif; */
    background-color: black;
  }

#search-bar-entry {
    display: none;
}

#search-bar-entry-mobile {
    display: none;
}

Start a Simli session with an agent ID and session token

/auto/start/{agent_id}

Location

Message

Error Type

ValidationError

HTTPValidationError

Simli

The API devs use to add faces to realtime AI agents

Welcome to Simli

Create Avatar

We have made some pre-made, default faces for you to use. In our app, you can create an agent [from existing face](https://app.simli.com/create/from-existing) or, use the [Agents API](/api-reference/endpoint/agent/agent-create) to create your own agent with one of these faces, or use the `faceID` directly in our JavaScript SDK.

Default Faces

Create interactive AI avatars with just a few API calls

Simli Auto

Embed a Simli Avatar on your website in a few minutes using Simli Auto.

Embed a Widget

Add dynamic emotions to your Simli Avatar to create more engaging and expressive interactions. This feature is only available in [Simli Auto](/api-reference/simli-auto).

Add Emotions

Create interactive AI avatars with full control over your AI stack

Simli Compose

JavaScript

JavaScript Auth

Python SDK

Discord Server

Create Simli Agent

OpenAI

Explore our open-source projects on GitHub integrating Simli with various AI agents

All Repos

Create Simli session token to be used in Simli sessions (i.e., the [/auto/start/{agent_id}](/api-reference/endpoint/simli-auto/start) endpoint)

/auto/token

Start a Simli session with body parameters (as opposed to using agent ID + session token)

/auto/start/configurable

Retrieve the conversation transcript for a specific session if transcript generation was enabled. If using the [auto/start/configurable](/api-reference/endpoint/simli-auto/start-configurable) API, `createTranscript` must be set to `true`. If using the [sessionToken](api-reference/endpoint/simli-auto/token)-based API, `createTranscript` must be set to `true` in the token configuration.

/auto/transcript/{session_id}

Custom LLM guide

/generateFaceID

/getRequestStatus

Create Agent

Update Agent

Delete Agent

Get Agent

Get All Agents

Get started creating using Simli WebRTC API

Custom WebRTC Client

Start a session and get it's session token

/startAudioToVideoSession

Get TURN servers if you need them for NAT avoidance

/getIceServers

This endpoint returns a url of an HLS .m3u8 playlist file along with an mp4 file.

/audioToVideoStream

Pipecat

LiveKit

Video Tutorials

Use Cases

Feature Your Video

The Simli speech-to-video API lets developers create lip-synced AI avatar interactions. With visual AI avatars, you can create anything! Mock interviews, sales assistants, language learning, coaching, customer-service training, historical characters, and so much more. To see it in action first, [try our demo](https://www.simli.com/demo). Ready to make your first one?

Simli Auto

Face ID Creation

Agents

WebRTC API

Content Creation

Integrate with Simli

/auto/start/{agent_id}

Headers

Path Parameters

Query Parameters

Response