Start Auto Session
curl --request POST \
--url https://api.simli.ai/auto/start/configurable \
--header 'Content-Type: application/json' \
--header 'x-simli-api-key: <api-key>' \
--data @- <<EOF
{
"faceId": "tmp9i8bbq7c",
"ttsProvider": "Cartesia",
"ttsAPIKey": "<string>",
"ttsModel": "sonic-turbo-2025-03-07",
"voiceId": "a167e0f3-df7e-4d52-a9c3-f949145efdab",
"systemPrompt": "You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.",
"firstMessage": "<string>",
"maxSessionLength": 3600,
"maxIdleTime": 300,
"language": "en",
"customLLMConfig": {
"model": "<string>",
"baseURL": "<string>",
"llmAPIKey": "<string>"
},
"llmConfig": {
"model": "gpt-4o-mini",
"provider": "OpenAI"
},
"createTranscript": false,
"model": "artalk"
}
EOFimport requests
url = "https://api.simli.ai/auto/start/configurable"
payload = {
"faceId": "tmp9i8bbq7c",
"ttsProvider": "Cartesia",
"ttsAPIKey": "<string>",
"ttsModel": "sonic-turbo-2025-03-07",
"voiceId": "a167e0f3-df7e-4d52-a9c3-f949145efdab",
"systemPrompt": "You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.",
"firstMessage": "<string>",
"maxSessionLength": 3600,
"maxIdleTime": 300,
"language": "en",
"customLLMConfig": {
"model": "<string>",
"baseURL": "<string>",
"llmAPIKey": "<string>"
},
"llmConfig": {
"model": "gpt-4o-mini",
"provider": "OpenAI"
},
"createTranscript": False,
"model": "artalk"
}
headers = {
"x-simli-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-simli-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
faceId: 'tmp9i8bbq7c',
ttsProvider: 'Cartesia',
ttsAPIKey: '<string>',
ttsModel: 'sonic-turbo-2025-03-07',
voiceId: 'a167e0f3-df7e-4d52-a9c3-f949145efdab',
systemPrompt: 'You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don\'t include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.',
firstMessage: '<string>',
maxSessionLength: 3600,
maxIdleTime: 300,
language: 'en',
customLLMConfig: {model: '<string>', baseURL: '<string>', llmAPIKey: '<string>'},
llmConfig: {model: 'gpt-4o-mini', provider: 'OpenAI'},
createTranscript: false,
model: 'artalk'
})
};
fetch('https://api.simli.ai/auto/start/configurable', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.simli.ai/auto/start/configurable",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'faceId' => 'tmp9i8bbq7c',
'ttsProvider' => 'Cartesia',
'ttsAPIKey' => '<string>',
'ttsModel' => 'sonic-turbo-2025-03-07',
'voiceId' => 'a167e0f3-df7e-4d52-a9c3-f949145efdab',
'systemPrompt' => 'You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don\'t include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.',
'firstMessage' => '<string>',
'maxSessionLength' => 3600,
'maxIdleTime' => 300,
'language' => 'en',
'customLLMConfig' => [
'model' => '<string>',
'baseURL' => '<string>',
'llmAPIKey' => '<string>'
],
'llmConfig' => [
'model' => 'gpt-4o-mini',
'provider' => 'OpenAI'
],
'createTranscript' => false,
'model' => 'artalk'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-simli-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.simli.ai/auto/start/configurable"
payload := strings.NewReader("{\n \"faceId\": \"tmp9i8bbq7c\",\n \"ttsProvider\": \"Cartesia\",\n \"ttsAPIKey\": \"<string>\",\n \"ttsModel\": \"sonic-turbo-2025-03-07\",\n \"voiceId\": \"a167e0f3-df7e-4d52-a9c3-f949145efdab\",\n \"systemPrompt\": \"You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.\",\n \"firstMessage\": \"<string>\",\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"language\": \"en\",\n \"customLLMConfig\": {\n \"model\": \"<string>\",\n \"baseURL\": \"<string>\",\n \"llmAPIKey\": \"<string>\"\n },\n \"llmConfig\": {\n \"model\": \"gpt-4o-mini\",\n \"provider\": \"OpenAI\"\n },\n \"createTranscript\": false,\n \"model\": \"artalk\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simli-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.simli.ai/auto/start/configurable")
.header("x-simli-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"faceId\": \"tmp9i8bbq7c\",\n \"ttsProvider\": \"Cartesia\",\n \"ttsAPIKey\": \"<string>\",\n \"ttsModel\": \"sonic-turbo-2025-03-07\",\n \"voiceId\": \"a167e0f3-df7e-4d52-a9c3-f949145efdab\",\n \"systemPrompt\": \"You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.\",\n \"firstMessage\": \"<string>\",\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"language\": \"en\",\n \"customLLMConfig\": {\n \"model\": \"<string>\",\n \"baseURL\": \"<string>\",\n \"llmAPIKey\": \"<string>\"\n },\n \"llmConfig\": {\n \"model\": \"gpt-4o-mini\",\n \"provider\": \"OpenAI\"\n },\n \"createTranscript\": false,\n \"model\": \"artalk\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simli.ai/auto/start/configurable")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simli-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"faceId\": \"tmp9i8bbq7c\",\n \"ttsProvider\": \"Cartesia\",\n \"ttsAPIKey\": \"<string>\",\n \"ttsModel\": \"sonic-turbo-2025-03-07\",\n \"voiceId\": \"a167e0f3-df7e-4d52-a9c3-f949145efdab\",\n \"systemPrompt\": \"You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.\",\n \"firstMessage\": \"<string>\",\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"language\": \"en\",\n \"customLLMConfig\": {\n \"model\": \"<string>\",\n \"baseURL\": \"<string>\",\n \"llmAPIKey\": \"<string>\"\n },\n \"llmConfig\": {\n \"model\": \"gpt-4o-mini\",\n \"provider\": \"OpenAI\"\n },\n \"createTranscript\": false,\n \"model\": \"artalk\"\n}"
response = http.request(request)
puts response.read_body{
"roomUrl": "<string>",
"sessionId": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Start Auto Session
deprecated
Start new Simli Auto Session without preconfigured agent
POST
/
auto
/
start
/
configurable
Start Auto Session
curl --request POST \
--url https://api.simli.ai/auto/start/configurable \
--header 'Content-Type: application/json' \
--header 'x-simli-api-key: <api-key>' \
--data @- <<EOF
{
"faceId": "tmp9i8bbq7c",
"ttsProvider": "Cartesia",
"ttsAPIKey": "<string>",
"ttsModel": "sonic-turbo-2025-03-07",
"voiceId": "a167e0f3-df7e-4d52-a9c3-f949145efdab",
"systemPrompt": "You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.",
"firstMessage": "<string>",
"maxSessionLength": 3600,
"maxIdleTime": 300,
"language": "en",
"customLLMConfig": {
"model": "<string>",
"baseURL": "<string>",
"llmAPIKey": "<string>"
},
"llmConfig": {
"model": "gpt-4o-mini",
"provider": "OpenAI"
},
"createTranscript": false,
"model": "artalk"
}
EOFimport requests
url = "https://api.simli.ai/auto/start/configurable"
payload = {
"faceId": "tmp9i8bbq7c",
"ttsProvider": "Cartesia",
"ttsAPIKey": "<string>",
"ttsModel": "sonic-turbo-2025-03-07",
"voiceId": "a167e0f3-df7e-4d52-a9c3-f949145efdab",
"systemPrompt": "You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.",
"firstMessage": "<string>",
"maxSessionLength": 3600,
"maxIdleTime": 300,
"language": "en",
"customLLMConfig": {
"model": "<string>",
"baseURL": "<string>",
"llmAPIKey": "<string>"
},
"llmConfig": {
"model": "gpt-4o-mini",
"provider": "OpenAI"
},
"createTranscript": False,
"model": "artalk"
}
headers = {
"x-simli-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-simli-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
faceId: 'tmp9i8bbq7c',
ttsProvider: 'Cartesia',
ttsAPIKey: '<string>',
ttsModel: 'sonic-turbo-2025-03-07',
voiceId: 'a167e0f3-df7e-4d52-a9c3-f949145efdab',
systemPrompt: 'You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don\'t include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.',
firstMessage: '<string>',
maxSessionLength: 3600,
maxIdleTime: 300,
language: 'en',
customLLMConfig: {model: '<string>', baseURL: '<string>', llmAPIKey: '<string>'},
llmConfig: {model: 'gpt-4o-mini', provider: 'OpenAI'},
createTranscript: false,
model: 'artalk'
})
};
fetch('https://api.simli.ai/auto/start/configurable', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.simli.ai/auto/start/configurable",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'faceId' => 'tmp9i8bbq7c',
'ttsProvider' => 'Cartesia',
'ttsAPIKey' => '<string>',
'ttsModel' => 'sonic-turbo-2025-03-07',
'voiceId' => 'a167e0f3-df7e-4d52-a9c3-f949145efdab',
'systemPrompt' => 'You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don\'t include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.',
'firstMessage' => '<string>',
'maxSessionLength' => 3600,
'maxIdleTime' => 300,
'language' => 'en',
'customLLMConfig' => [
'model' => '<string>',
'baseURL' => '<string>',
'llmAPIKey' => '<string>'
],
'llmConfig' => [
'model' => 'gpt-4o-mini',
'provider' => 'OpenAI'
],
'createTranscript' => false,
'model' => 'artalk'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-simli-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.simli.ai/auto/start/configurable"
payload := strings.NewReader("{\n \"faceId\": \"tmp9i8bbq7c\",\n \"ttsProvider\": \"Cartesia\",\n \"ttsAPIKey\": \"<string>\",\n \"ttsModel\": \"sonic-turbo-2025-03-07\",\n \"voiceId\": \"a167e0f3-df7e-4d52-a9c3-f949145efdab\",\n \"systemPrompt\": \"You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.\",\n \"firstMessage\": \"<string>\",\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"language\": \"en\",\n \"customLLMConfig\": {\n \"model\": \"<string>\",\n \"baseURL\": \"<string>\",\n \"llmAPIKey\": \"<string>\"\n },\n \"llmConfig\": {\n \"model\": \"gpt-4o-mini\",\n \"provider\": \"OpenAI\"\n },\n \"createTranscript\": false,\n \"model\": \"artalk\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simli-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.simli.ai/auto/start/configurable")
.header("x-simli-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"faceId\": \"tmp9i8bbq7c\",\n \"ttsProvider\": \"Cartesia\",\n \"ttsAPIKey\": \"<string>\",\n \"ttsModel\": \"sonic-turbo-2025-03-07\",\n \"voiceId\": \"a167e0f3-df7e-4d52-a9c3-f949145efdab\",\n \"systemPrompt\": \"You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.\",\n \"firstMessage\": \"<string>\",\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"language\": \"en\",\n \"customLLMConfig\": {\n \"model\": \"<string>\",\n \"baseURL\": \"<string>\",\n \"llmAPIKey\": \"<string>\"\n },\n \"llmConfig\": {\n \"model\": \"gpt-4o-mini\",\n \"provider\": \"OpenAI\"\n },\n \"createTranscript\": false,\n \"model\": \"artalk\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simli.ai/auto/start/configurable")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simli-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"faceId\": \"tmp9i8bbq7c\",\n \"ttsProvider\": \"Cartesia\",\n \"ttsAPIKey\": \"<string>\",\n \"ttsModel\": \"sonic-turbo-2025-03-07\",\n \"voiceId\": \"a167e0f3-df7e-4d52-a9c3-f949145efdab\",\n \"systemPrompt\": \"You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.\",\n \"firstMessage\": \"<string>\",\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"language\": \"en\",\n \"customLLMConfig\": {\n \"model\": \"<string>\",\n \"baseURL\": \"<string>\",\n \"llmAPIKey\": \"<string>\"\n },\n \"llmConfig\": {\n \"model\": \"gpt-4o-mini\",\n \"provider\": \"OpenAI\"\n },\n \"createTranscript\": false,\n \"model\": \"artalk\"\n}"
response = http.request(request)
puts response.read_body{
"roomUrl": "<string>",
"sessionId": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Available options:
ElevenLabs, PlayHT, Cartesia, User systemPrompt
string | null
default:You are Chatbot, a friendly, helpful robot. Your goal is to demonstrate your capabilities in a succinct way. Your output will be converted to audio so don't include special characters in your answers. Respond to what the user said in a creative and helpful way, but keep your responses brief.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
fasttalk, artalk ⌘I