Compose Session Token
curl --request POST \
--url https://api.simli.ai/compose/token \
--header 'Content-Type: application/json' \
--header 'x-simli-api-key: <api-key>' \
--data '
{
"faceId": "<string>",
"apiVersion": "v2",
"sessionAggregator": "<string>",
"handleSilence": true,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16",
"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"
}
'import requests
url = "https://api.simli.ai/compose/token"
payload = {
"faceId": "<string>",
"apiVersion": "v2",
"sessionAggregator": "<string>",
"handleSilence": True,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16",
"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: '<string>',
apiVersion: 'v2',
sessionAggregator: '<string>',
handleSilence: true,
maxSessionLength: 3600,
maxIdleTime: 300,
startFrame: 0,
audioInputFormat: 'pcm16',
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/compose/token', 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/compose/token",
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' => '<string>',
'apiVersion' => 'v2',
'sessionAggregator' => '<string>',
'handleSilence' => true,
'maxSessionLength' => 3600,
'maxIdleTime' => 300,
'startFrame' => 0,
'audioInputFormat' => 'pcm16',
'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/compose/token"
payload := strings.NewReader("{\n \"faceId\": \"<string>\",\n \"apiVersion\": \"v2\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\",\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/compose/token")
.header("x-simli-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"faceId\": \"<string>\",\n \"apiVersion\": \"v2\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\",\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/compose/token")
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\": \"<string>\",\n \"apiVersion\": \"v2\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\",\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{
"session_token": "<string>",
"warnings": [
"<string>"
]
}{
"session_token": "<string>",
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Advanced: Custom Simli Client
/compose/token
Start a session and get it’s session token
POST
/
compose
/
token
Compose Session Token
curl --request POST \
--url https://api.simli.ai/compose/token \
--header 'Content-Type: application/json' \
--header 'x-simli-api-key: <api-key>' \
--data '
{
"faceId": "<string>",
"apiVersion": "v2",
"sessionAggregator": "<string>",
"handleSilence": true,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16",
"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"
}
'import requests
url = "https://api.simli.ai/compose/token"
payload = {
"faceId": "<string>",
"apiVersion": "v2",
"sessionAggregator": "<string>",
"handleSilence": True,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16",
"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: '<string>',
apiVersion: 'v2',
sessionAggregator: '<string>',
handleSilence: true,
maxSessionLength: 3600,
maxIdleTime: 300,
startFrame: 0,
audioInputFormat: 'pcm16',
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/compose/token', 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/compose/token",
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' => '<string>',
'apiVersion' => 'v2',
'sessionAggregator' => '<string>',
'handleSilence' => true,
'maxSessionLength' => 3600,
'maxIdleTime' => 300,
'startFrame' => 0,
'audioInputFormat' => 'pcm16',
'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/compose/token"
payload := strings.NewReader("{\n \"faceId\": \"<string>\",\n \"apiVersion\": \"v2\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\",\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/compose/token")
.header("x-simli-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"faceId\": \"<string>\",\n \"apiVersion\": \"v2\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\",\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/compose/token")
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\": \"<string>\",\n \"apiVersion\": \"v2\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\",\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{
"session_token": "<string>",
"warnings": [
"<string>"
]
}{
"session_token": "<string>",
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
Allowed value:
"v2"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 >= 512Height of the streamed video in pixels. See streaming_width.
Required range:
x >= 512Where the avatar sits across the canvas, from 0 (left) to 1 (right). Trinity-2 only.
Required range:
0 <= x <= 1Where the avatar sits down the canvas, from 0 (top) to 1 (bottom). Trinity-2 only.
Required range:
0 <= x <= 1The 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
Show child attributes
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. A streaming session can change it afterwards with BG_ messages.
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. A streaming session can change it afterwards with FG_ messages.