Skip to main content
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"
}
EOF
{
  "roomUrl": "<string>",
  "sessionId": "<string>"
}

Authorizations

x-simli-api-key
string
header
required

Body

application/json
faceId
string
default:tmp9i8bbq7c
ttsProvider
enum<string>
default:Cartesia
Available options:
ElevenLabs,
PlayHT,
Cartesia,
User
ttsAPIKey
string | null
ttsModel
string
default:sonic-turbo-2025-03-07
voiceId
string
default:a167e0f3-df7e-4d52-a9c3-f949145efdab
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.
firstMessage
string | null
maxSessionLength
integer
default:3600
maxIdleTime
integer
default:300
language
string
default:en
customLLMConfig
CustomLLMConfig · object
llmConfig
LLMConfig · object
createTranscript
boolean
default:false
model
enum<string>
default:artalk
Available options:
fasttalk,
artalk

Response

Successful Response

roomUrl
string
required
sessionId
string
required