Skip to main content
POST
/
v1
/
characters
Initialize character generation
curl --request POST \
  --url http://api/v1/characters \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "text": "",
  "voiceId": "<string>",
  "voiceUrl": "<string>",
  "avatarImage": "<string>",
  "aspectRatio": "1:1",
  "audioSource": "audio",
  "avatarImageInput": {
    "seed": 123,
    "prompt": "<string>"
  }
}
'
{
  "jobId": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
content-length
integer
default:-1

Body

application/json
​
text
string
default:""

text to convert to audio. Ignored if audio_source is not tts

​
voiceId
string | null

Voice ID

​
voiceUrl
string | null

URL of audio uploaded using the /v1/audio endpoint

​
avatarImage
string | null

URL of image uploaded via /v1/portrait or base64-encoded image

​
aspectRatio
enum<string>
default:1:1

Desired aspect ratio for the generated video

Available options:
1:1,
16:9,
9:16
​
audioSource
enum<string>
default:audio

tts for text to speech or audio

Available options:
tts,
audio
​
avatarImageInput
object | null

Image metadata

Response

Successful Response

​
jobId
string
required