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": "<string>",
"sessionAggregator": "<string>",
"handleSilence": true,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16"
}
'import requests
url = "https://api.simli.ai/compose/token"
payload = {
"faceId": "<string>",
"apiVersion": "<string>",
"sessionAggregator": "<string>",
"handleSilence": True,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16"
}
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: '<string>',
sessionAggregator: '<string>',
handleSilence: true,
maxSessionLength: 3600,
maxIdleTime: 300,
startFrame: 0,
audioInputFormat: 'pcm16'
})
};
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' => '<string>',
'sessionAggregator' => '<string>',
'handleSilence' => true,
'maxSessionLength' => 3600,
'maxIdleTime' => 300,
'startFrame' => 0,
'audioInputFormat' => 'pcm16'
]),
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\": \"<string>\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\"\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\": \"<string>\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\"\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\": \"<string>\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\"\n}"
response = http.request(request)
puts response.read_body{
"session_token": "<string>"
}{
"session_token": "<string>",
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Compose Session Token
Create a temporary Simli Compose 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": "<string>",
"sessionAggregator": "<string>",
"handleSilence": true,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16"
}
'import requests
url = "https://api.simli.ai/compose/token"
payload = {
"faceId": "<string>",
"apiVersion": "<string>",
"sessionAggregator": "<string>",
"handleSilence": True,
"maxSessionLength": 3600,
"maxIdleTime": 300,
"startFrame": 0,
"audioInputFormat": "pcm16"
}
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: '<string>',
sessionAggregator: '<string>',
handleSilence: true,
maxSessionLength: 3600,
maxIdleTime: 300,
startFrame: 0,
audioInputFormat: 'pcm16'
})
};
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' => '<string>',
'sessionAggregator' => '<string>',
'handleSilence' => true,
'maxSessionLength' => 3600,
'maxIdleTime' => 300,
'startFrame' => 0,
'audioInputFormat' => 'pcm16'
]),
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\": \"<string>\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\"\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\": \"<string>\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\"\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\": \"<string>\",\n \"sessionAggregator\": \"<string>\",\n \"handleSilence\": true,\n \"maxSessionLength\": 3600,\n \"maxIdleTime\": 300,\n \"startFrame\": 0,\n \"audioInputFormat\": \"pcm16\"\n}"
response = http.request(request)
puts response.read_body{
"session_token": "<string>"
}{
"session_token": "<string>",
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Response
Successful Response
⌘I