Skip to main content
POST
/
startAudioToVideoSession
Start Audio To Video Session
curl --request POST \
  --url https://api.simli.ai/startAudioToVideoSession \
  --header 'Content-Type: application/json' \
  --data '
{
  "faceId": "<string>",
  "apiKey": "<string>",
  "apiVersion": "v1",
  "isJPG": false,
  "syncAudio": false,
  "audioInputFormat": "pcm16",
  "batchSize": 1,
  "handleSilence": true,
  "maxSessionLength": 3600,
  "maxIdleTime": 300,
  "preloadAvatar": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
Please do note that the API might respond with server overloaded. If your product requires dedicated slots, you can contact us.

Body

application/json
faceId
string
required
apiKey
string
required
apiVersion
string
default:v1
isJPG
boolean
default:false
syncAudio
boolean
default:false
audioInputFormat
string
default:pcm16
batchSize
integer
default:1
handleSilence
boolean
default:true
maxSessionLength
integer
default:3600
maxIdleTime
integer
default:300
preloadAvatar
boolean
default:false

Response

Successful Response