Create interactive AI avatars with just a few API calls
Simli Auto is our managed API and provides streamlined way to integrate conversational AI agents into your applications with minimal setup.
Simli Auto now supports custom LLMs, but if you need even more composability (such as making your custom voice bot), check out the Simli Compose API Reference instead.
For changing the interaction languages, you can look at the support list on Deepgram’s website
There are two ways to build with Simli Auto. The recommended way for most people is using session tokens to authenticate:
POST /auto/token
: Creates a new session token for authentication. Requires your Simli API key and optionally a TTS API key.POST /auto/start/{agent_id}
: Starts a session using token in the header for authentication (see API reference).An alternative way to start a session without creating a token first is to use this endpoint:
POST /auto/start/configurable
: Initializes a new end-to-end interactive session with an AI avatar. Configure TTS provider, language, and other session parameters.For conversation transcripts:
GET /auto/transcript/{sessionId}
: Retrieves the conversation transcript for a specific session if transcript generation was enabled.To start using the Simli Auto API, you’ll need:
Here’s a basic flow to get started:
Simli Auto supports integration with any OpenAI-compatible LLM API. To use your own LLM:
You can customize various session parameters:
maxSessionLength
: Maximum duration of the session in seconds (default: 3600)maxIdleTime
: Maximum idle time before session timeout in seconds (default: 300)systemPrompt
: Custom prompt to define the AI’s behaviorfirstMessage
: Initial message from the AI when session startsSession Management
Resource Optimization
Error Handling
Please refer to your API plan for specific rate limits and quotas. Ensure your application handles rate limiting appropriately to maintain optimal performance.
For more detailed information about specific endpoints and features, navigate through the API reference sections.
Create interactive AI avatars with just a few API calls
Simli Auto is our managed API and provides streamlined way to integrate conversational AI agents into your applications with minimal setup.
Simli Auto now supports custom LLMs, but if you need even more composability (such as making your custom voice bot), check out the Simli Compose API Reference instead.
For changing the interaction languages, you can look at the support list on Deepgram’s website
There are two ways to build with Simli Auto. The recommended way for most people is using session tokens to authenticate:
POST /auto/token
: Creates a new session token for authentication. Requires your Simli API key and optionally a TTS API key.POST /auto/start/{agent_id}
: Starts a session using token in the header for authentication (see API reference).An alternative way to start a session without creating a token first is to use this endpoint:
POST /auto/start/configurable
: Initializes a new end-to-end interactive session with an AI avatar. Configure TTS provider, language, and other session parameters.For conversation transcripts:
GET /auto/transcript/{sessionId}
: Retrieves the conversation transcript for a specific session if transcript generation was enabled.To start using the Simli Auto API, you’ll need:
Here’s a basic flow to get started:
Simli Auto supports integration with any OpenAI-compatible LLM API. To use your own LLM:
You can customize various session parameters:
maxSessionLength
: Maximum duration of the session in seconds (default: 3600)maxIdleTime
: Maximum idle time before session timeout in seconds (default: 300)systemPrompt
: Custom prompt to define the AI’s behaviorfirstMessage
: Initial message from the AI when session startsSession Management
Resource Optimization
Error Handling
Please refer to your API plan for specific rate limits and quotas. Ensure your application handles rate limiting appropriately to maintain optimal performance.
For more detailed information about specific endpoints and features, navigate through the API reference sections.