Skip to main content
POST
cURL

Quick Start Guide

Bring Your Own Avatar

Authorizations

X-API-ID
string
header
required

API ID, from your settings page.

X-API-KEY
string
header
required

API Key, from your settings page.

Body

gender
enum<string>
required

gender of the persona

  • m - Male
  • f - Female
  • nb - Non-Binary
Available options:
m,
f,
nb
creator_name
string
required

Name of the persona, used to identify the real person, not for display

Maximum string length: 255
video_scene
string | null

A word to describe the background setting. API user rely on this

Maximum string length: 255
keywords
string | null

keywords (comma separated)

Maximum string length: 255
lipsync_input
string<uri>
gdown_url
string<uri>
labels
string[]
original_voice_provider
enum<string>

Provider that minted original_voice_provider_id (paired cache field). Default ELEVENLABS is correct for pre-Workstream-C rows whose cache could only ever hold 11labs ids.

  • elevenlabs - ElevenLabs
  • minimax - MiniMax
  • fishaudio - FishAudio
Available options:
elevenlabs,
minimax,
fishaudio
webhook_url
string<uri> | null

Webhook url, when the creator is created, we will send a webhook to the url(only for api user)

Maximum string length: 200

Response

201 - application/json
id
string<uuid>
required
read-only
gender
enum<string>
required

gender of the persona

  • m - Male
  • f - Female
  • nb - Non-Binary
Available options:
m,
f,
nb
creator_name
string
required

Name of the persona, used to identify the real person, not for display

Maximum string length: 255

The URL of the consent video

lipsync_input_url
string
required
read-only
matching_voice_non_null
string
required
read-only
process_status
enum<string>
required

The status of creating process of the creator, if not done, it should not be shown in the UI

  • pending - Pending
  • processing - Processing
  • voice_creating - Voice Creating
  • video_validating - Video Validating
  • crop_and_matte - Crop And Matte
  • reviewing - Reviewing
  • done - Done
  • failed - Failed
  • rejected - Rejected
Available options:
pending,
processing,
voice_creating,
video_validating,
crop_and_matte,
reviewing,
done,
failed,
rejected
failed_reason
string | null
required
read-only

The reason why the creator creation failed, if not failed, it should be empty

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
video_scene
string | null

A word to describe the background setting. API user rely on this

Maximum string length: 255
keywords
string | null

keywords (comma separated)

Maximum string length: 255
lipsync_input
string<uri>
gdown_url
string<uri>
labels
string[]
original_voice_provider
enum<string>

Provider that minted original_voice_provider_id (paired cache field). Default ELEVENLABS is correct for pre-Workstream-C rows whose cache could only ever hold 11labs ids.

  • elevenlabs - ElevenLabs
  • minimax - MiniMax
  • fishaudio - FishAudio
Available options:
elevenlabs,
minimax,
fishaudio
webhook_url
string<uri> | null

Webhook url, when the creator is created, we will send a webhook to the url(only for api user)

Maximum string length: 200