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": "bf13113a-355a-4d97-8b90-4edccd1da7b2",
  "ttsProvider": "Inworld",
  "ttsAPIKey": "<string>",
  "ttsModel": "inworld-tts-2",
  "voiceId": "Ashley",
  "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-6-luna",
    "provider": "OpenAI"
  },
  "createTranscript": false,
  "model": "fasttalk",
  "disableSuperRes": false,
  "streaming_width": 768,
  "streaming_height": 768,
  "avatar_position_x": 0.5,
  "avatar_position_y": 1,
  "camera": {
    "pos_x_off": 0,
    "pos_y_off": 0,
    "pos_z_off": 0,
    "rot_x_off": 0,
    "rot_y_off": 0,
    "rot_z_off": 0,
    "zoom": 1,
    "orbit_x_off": 0,
    "orbit_y_off": 0
  },
  "background_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "foreground_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
EOF

import requests

url = "https://api.simli.ai/auto/start/configurable"

payload = {
    "faceId": "bf13113a-355a-4d97-8b90-4edccd1da7b2",
    "ttsProvider": "Inworld",
    "ttsAPIKey": "<string>",
    "ttsModel": "inworld-tts-2",
    "voiceId": "Ashley",
    "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-6-luna",
        "provider": "OpenAI"
    },
    "createTranscript": False,
    "model": "fasttalk",
    "disableSuperRes": False,
    "streaming_width": 768,
    "streaming_height": 768,
    "avatar_position_x": 0.5,
    "avatar_position_y": 1,
    "camera": {
        "pos_x_off": 0,
        "pos_y_off": 0,
        "pos_z_off": 0,
        "rot_x_off": 0,
        "rot_y_off": 0,
        "rot_z_off": 0,
        "zoom": 1,
        "orbit_x_off": 0,
        "orbit_y_off": 0
    },
    "background_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "foreground_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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: 'bf13113a-355a-4d97-8b90-4edccd1da7b2',
    ttsProvider: 'Inworld',
    ttsAPIKey: '<string>',
    ttsModel: 'inworld-tts-2',
    voiceId: 'Ashley',
    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-6-luna', provider: 'OpenAI'},
    createTranscript: false,
    model: 'fasttalk',
    disableSuperRes: false,
    streaming_width: 768,
    streaming_height: 768,
    avatar_position_x: 0.5,
    avatar_position_y: 1,
    camera: {
      pos_x_off: 0,
      pos_y_off: 0,
      pos_z_off: 0,
      rot_x_off: 0,
      rot_y_off: 0,
      rot_z_off: 0,
      zoom: 1,
      orbit_x_off: 0,
      orbit_y_off: 0
    },
    background_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    foreground_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

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' => 'bf13113a-355a-4d97-8b90-4edccd1da7b2',
    'ttsProvider' => 'Inworld',
    'ttsAPIKey' => '<string>',
    'ttsModel' => 'inworld-tts-2',
    'voiceId' => 'Ashley',
    '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-6-luna',
        'provider' => 'OpenAI'
    ],
    'createTranscript' => false,
    'model' => 'fasttalk',
    'disableSuperRes' => false,
    'streaming_width' => 768,
    'streaming_height' => 768,
    'avatar_position_x' => 0.5,
    'avatar_position_y' => 1,
    'camera' => [
        'pos_x_off' => 0,
        'pos_y_off' => 0,
        'pos_z_off' => 0,
        'rot_x_off' => 0,
        'rot_y_off' => 0,
        'rot_z_off' => 0,
        'zoom' => 1,
        'orbit_x_off' => 0,
        'orbit_y_off' => 0
    ],
    'background_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'foreground_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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\": \"bf13113a-355a-4d97-8b90-4edccd1da7b2\",\n  \"ttsProvider\": \"Inworld\",\n  \"ttsAPIKey\": \"<string>\",\n  \"ttsModel\": \"inworld-tts-2\",\n  \"voiceId\": \"Ashley\",\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-6-luna\",\n    \"provider\": \"OpenAI\"\n  },\n  \"createTranscript\": false,\n  \"model\": \"fasttalk\",\n  \"disableSuperRes\": false,\n  \"streaming_width\": 768,\n  \"streaming_height\": 768,\n  \"avatar_position_x\": 0.5,\n  \"avatar_position_y\": 1,\n  \"camera\": {\n    \"pos_x_off\": 0,\n    \"pos_y_off\": 0,\n    \"pos_z_off\": 0,\n    \"rot_x_off\": 0,\n    \"rot_y_off\": 0,\n    \"rot_z_off\": 0,\n    \"zoom\": 1,\n    \"orbit_x_off\": 0,\n    \"orbit_y_off\": 0\n  },\n  \"background_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"foreground_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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\": \"bf13113a-355a-4d97-8b90-4edccd1da7b2\",\n  \"ttsProvider\": \"Inworld\",\n  \"ttsAPIKey\": \"<string>\",\n  \"ttsModel\": \"inworld-tts-2\",\n  \"voiceId\": \"Ashley\",\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-6-luna\",\n    \"provider\": \"OpenAI\"\n  },\n  \"createTranscript\": false,\n  \"model\": \"fasttalk\",\n  \"disableSuperRes\": false,\n  \"streaming_width\": 768,\n  \"streaming_height\": 768,\n  \"avatar_position_x\": 0.5,\n  \"avatar_position_y\": 1,\n  \"camera\": {\n    \"pos_x_off\": 0,\n    \"pos_y_off\": 0,\n    \"pos_z_off\": 0,\n    \"rot_x_off\": 0,\n    \"rot_y_off\": 0,\n    \"rot_z_off\": 0,\n    \"zoom\": 1,\n    \"orbit_x_off\": 0,\n    \"orbit_y_off\": 0\n  },\n  \"background_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"foreground_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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\": \"bf13113a-355a-4d97-8b90-4edccd1da7b2\",\n  \"ttsProvider\": \"Inworld\",\n  \"ttsAPIKey\": \"<string>\",\n  \"ttsModel\": \"inworld-tts-2\",\n  \"voiceId\": \"Ashley\",\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-6-luna\",\n    \"provider\": \"OpenAI\"\n  },\n  \"createTranscript\": false,\n  \"model\": \"fasttalk\",\n  \"disableSuperRes\": false,\n  \"streaming_width\": 768,\n  \"streaming_height\": 768,\n  \"avatar_position_x\": 0.5,\n  \"avatar_position_y\": 1,\n  \"camera\": {\n    \"pos_x_off\": 0,\n    \"pos_y_off\": 0,\n    \"pos_z_off\": 0,\n    \"rot_x_off\": 0,\n    \"rot_y_off\": 0,\n    \"rot_z_off\": 0,\n    \"zoom\": 1,\n    \"orbit_x_off\": 0,\n    \"orbit_y_off\": 0\n  },\n  \"background_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"foreground_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "roomUrl": "<string>",
  "sessionId": "<string>",
  "warnings": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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": "bf13113a-355a-4d97-8b90-4edccd1da7b2",
  "ttsProvider": "Inworld",
  "ttsAPIKey": "<string>",
  "ttsModel": "inworld-tts-2",
  "voiceId": "Ashley",
  "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-6-luna",
    "provider": "OpenAI"
  },
  "createTranscript": false,
  "model": "fasttalk",
  "disableSuperRes": false,
  "streaming_width": 768,
  "streaming_height": 768,
  "avatar_position_x": 0.5,
  "avatar_position_y": 1,
  "camera": {
    "pos_x_off": 0,
    "pos_y_off": 0,
    "pos_z_off": 0,
    "rot_x_off": 0,
    "rot_y_off": 0,
    "rot_z_off": 0,
    "zoom": 1,
    "orbit_x_off": 0,
    "orbit_y_off": 0
  },
  "background_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "foreground_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
EOF

import requests

url = "https://api.simli.ai/auto/start/configurable"

payload = {
    "faceId": "bf13113a-355a-4d97-8b90-4edccd1da7b2",
    "ttsProvider": "Inworld",
    "ttsAPIKey": "<string>",
    "ttsModel": "inworld-tts-2",
    "voiceId": "Ashley",
    "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-6-luna",
        "provider": "OpenAI"
    },
    "createTranscript": False,
    "model": "fasttalk",
    "disableSuperRes": False,
    "streaming_width": 768,
    "streaming_height": 768,
    "avatar_position_x": 0.5,
    "avatar_position_y": 1,
    "camera": {
        "pos_x_off": 0,
        "pos_y_off": 0,
        "pos_z_off": 0,
        "rot_x_off": 0,
        "rot_y_off": 0,
        "rot_z_off": 0,
        "zoom": 1,
        "orbit_x_off": 0,
        "orbit_y_off": 0
    },
    "background_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "foreground_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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: 'bf13113a-355a-4d97-8b90-4edccd1da7b2',
    ttsProvider: 'Inworld',
    ttsAPIKey: '<string>',
    ttsModel: 'inworld-tts-2',
    voiceId: 'Ashley',
    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-6-luna', provider: 'OpenAI'},
    createTranscript: false,
    model: 'fasttalk',
    disableSuperRes: false,
    streaming_width: 768,
    streaming_height: 768,
    avatar_position_x: 0.5,
    avatar_position_y: 1,
    camera: {
      pos_x_off: 0,
      pos_y_off: 0,
      pos_z_off: 0,
      rot_x_off: 0,
      rot_y_off: 0,
      rot_z_off: 0,
      zoom: 1,
      orbit_x_off: 0,
      orbit_y_off: 0
    },
    background_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    foreground_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

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' => 'bf13113a-355a-4d97-8b90-4edccd1da7b2',
    'ttsProvider' => 'Inworld',
    'ttsAPIKey' => '<string>',
    'ttsModel' => 'inworld-tts-2',
    'voiceId' => 'Ashley',
    '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-6-luna',
        'provider' => 'OpenAI'
    ],
    'createTranscript' => false,
    'model' => 'fasttalk',
    'disableSuperRes' => false,
    'streaming_width' => 768,
    'streaming_height' => 768,
    'avatar_position_x' => 0.5,
    'avatar_position_y' => 1,
    'camera' => [
        'pos_x_off' => 0,
        'pos_y_off' => 0,
        'pos_z_off' => 0,
        'rot_x_off' => 0,
        'rot_y_off' => 0,
        'rot_z_off' => 0,
        'zoom' => 1,
        'orbit_x_off' => 0,
        'orbit_y_off' => 0
    ],
    'background_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'foreground_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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\": \"bf13113a-355a-4d97-8b90-4edccd1da7b2\",\n  \"ttsProvider\": \"Inworld\",\n  \"ttsAPIKey\": \"<string>\",\n  \"ttsModel\": \"inworld-tts-2\",\n  \"voiceId\": \"Ashley\",\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-6-luna\",\n    \"provider\": \"OpenAI\"\n  },\n  \"createTranscript\": false,\n  \"model\": \"fasttalk\",\n  \"disableSuperRes\": false,\n  \"streaming_width\": 768,\n  \"streaming_height\": 768,\n  \"avatar_position_x\": 0.5,\n  \"avatar_position_y\": 1,\n  \"camera\": {\n    \"pos_x_off\": 0,\n    \"pos_y_off\": 0,\n    \"pos_z_off\": 0,\n    \"rot_x_off\": 0,\n    \"rot_y_off\": 0,\n    \"rot_z_off\": 0,\n    \"zoom\": 1,\n    \"orbit_x_off\": 0,\n    \"orbit_y_off\": 0\n  },\n  \"background_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"foreground_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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\": \"bf13113a-355a-4d97-8b90-4edccd1da7b2\",\n  \"ttsProvider\": \"Inworld\",\n  \"ttsAPIKey\": \"<string>\",\n  \"ttsModel\": \"inworld-tts-2\",\n  \"voiceId\": \"Ashley\",\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-6-luna\",\n    \"provider\": \"OpenAI\"\n  },\n  \"createTranscript\": false,\n  \"model\": \"fasttalk\",\n  \"disableSuperRes\": false,\n  \"streaming_width\": 768,\n  \"streaming_height\": 768,\n  \"avatar_position_x\": 0.5,\n  \"avatar_position_y\": 1,\n  \"camera\": {\n    \"pos_x_off\": 0,\n    \"pos_y_off\": 0,\n    \"pos_z_off\": 0,\n    \"rot_x_off\": 0,\n    \"rot_y_off\": 0,\n    \"rot_z_off\": 0,\n    \"zoom\": 1,\n    \"orbit_x_off\": 0,\n    \"orbit_y_off\": 0\n  },\n  \"background_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"foreground_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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\": \"bf13113a-355a-4d97-8b90-4edccd1da7b2\",\n  \"ttsProvider\": \"Inworld\",\n  \"ttsAPIKey\": \"<string>\",\n  \"ttsModel\": \"inworld-tts-2\",\n  \"voiceId\": \"Ashley\",\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-6-luna\",\n    \"provider\": \"OpenAI\"\n  },\n  \"createTranscript\": false,\n  \"model\": \"fasttalk\",\n  \"disableSuperRes\": false,\n  \"streaming_width\": 768,\n  \"streaming_height\": 768,\n  \"avatar_position_x\": 0.5,\n  \"avatar_position_y\": 1,\n  \"camera\": {\n    \"pos_x_off\": 0,\n    \"pos_y_off\": 0,\n    \"pos_z_off\": 0,\n    \"rot_x_off\": 0,\n    \"rot_y_off\": 0,\n    \"rot_z_off\": 0,\n    \"zoom\": 1,\n    \"orbit_x_off\": 0,\n    \"orbit_y_off\": 0\n  },\n  \"background_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"foreground_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "roomUrl": "<string>",
  "sessionId": "<string>",
  "warnings": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-simli-api-key

string

header

required

Body

application/json

faceId

string

default:bf13113a-355a-4d97-8b90-4edccd1da7b2

ttsProvider

enum<string>

default:Inworld

Available options:

ElevenLabs,

Cartesia,

Inworld,

User

ttsAPIKey

string | null

ttsModel

string

default:inworld-tts-2

Defaults to Inworld's model; with ttsProvider Cartesia, to sonic-turbo-2025-03-07.

voiceId

string

default:Ashley

The voice's ID at the voice provider (Inworld voices go by name). Defaults to Inworld's Ashley; with ttsProvider Cartesia, to 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

introAnimation

enum<string> | null

An animation the avatar plays as it opens the session, when the user joins (with firstMessage, if there is one). Trinity-2 faces only; the others ignore it. Leave it out for no animation.

Available options:

g003_wave_goodbye_solo,

speaking_hands_explaining,

wave

maxSessionLength

integer

default:3600

maxIdleTime

integer

default:300

language

string

default:en

customLLMConfig

CustomLLMConfig · object | null

Show child attributes

llmConfig

LLMConfig · object

Show child attributes

createTranscript

boolean

default:false

model

enum<string>

default:fasttalk

Available options:

fasttalk

disableSuperRes

boolean

default:false

Turns off the face restoration pass on legacy faces.

streaming_width

integer

default:768

Width of the streamed video in pixels, Trinity-2 faces only (the others keep their own frame size). At least 512, and with streaming_height one of 1:1, 16:9 or 9:16, otherwise a 422. A canvas larger than the avatar's frame is padded with its background; a smaller one crops a window out of it.

Required range: x >= 512

streaming_height

integer

default:768

Height of the streamed video in pixels. See streaming_width.

Required range: x >= 512

avatar_position_x

number

default:0.5

Where the avatar sits across the canvas, from 0 (left) to 1 (right). Trinity-2 only.

Required range: 0 <= x <= 1

avatar_position_y

number

default:1

Where the avatar sits down the canvas, from 0 (top) to 1 (bottom). Trinity-2 only.

Required range: 0 <= x <= 1

camera

CameraSetting · object | null

The camera the session starts with, on top of the avatar's own framing. Trinity-2 only. Leave it out to keep the avatar's framing. A streaming session can move it afterwards with CAM_ messages.

Show child attributes

background_id

string<uuid> | null

One of your uploaded backgrounds, by the id POST /assets/backgrounds returned, to show behind the avatar, cropped to fill the canvas. Trinity-2 only. Leave it out for the avatar's own. An id that is not one of your account's is dropped with a warning, and the session uses the avatar's own. An image is not accepted: upload it first. Your app can change it in the session by sending the room an app message {"type": "simli-background", "id": ""}.

foreground_id

string<uuid> | null

One of your uploaded foregrounds, by the id POST /assets/foregrounds returned, laid over the avatar through its transparency and cropped to fill the canvas. Trinity-2 only; otherwise as background_id. Your app can change it with {"type": "simli-foreground", "id": ""}.

Response

Successful Response

roomUrl

string

required

sessionId

string

required

warnings

string[]

Deprecations, starting camera fields outside their supported range, and background_id / foreground_id dropped as not your account's (the avatar's own is used). The session starts regardless.

Endpoints

WebSockets

OpenAPI Specs (Agent Friendly Format)

Simli Auto Guides (deprecated)

Start Auto Session

Authorizations

Body

Response