Video

Video generation and avatar operations

Get available avatars

get

List all available avatars for video generation

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful response

application/json
idstringOptional

Avatar identifier

namestringOptional

Avatar display name

genderstring ยท enumOptional

Avatar gender (M = Male, F = Female)

Possible values:
get
/video/GetAvatars

Get shorts videos

get

List all shorts videos for the authenticated user (includes pending, processing, completed, and failed)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful response

application/json
idstringOptional

Short video identifier

statusintegerOptional

Status code (0 = pending, 10-90 = processing, 100 = completed, -1 = failed)

requestedOnstring ยท date-timeOptional

Request creation date

processingOnstring ยท date-timeOptional

Processing start date

succeededOnstring ยท date-timeOptional

Completion date

requestTypeIdintegerOptional

Request type ID (4 = Short)

callbackDatastringOptional

Custom callback data

audioUrlstringOptional

URL to the audio used for the short

videoUrlstringOptional

URL to the generated short video (when completed)

imageUrlstringOptional

URL to the thumbnail image (when completed)

audioTitlestringOptional

Title of the short video

responseTextstringOptional

Text content used in the short

errorOnstring ยท date-timeOptional

Error occurrence date (if applicable)

errorMessagestringOptional

Error message (if applicable)

get
/video/GetShorts

Create shorts

post

Create short videos from audio content or feeds

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
audioUrlstringOptional

URL to the audio file to create shorts from (optional if feedIds provided)

feedIdsstring[]Optional

Array of feed IDs to generate content from (optional if audioUrl provided)

promptstringOptional

Optional instructions for short creation

avatar1stringRequired

ID of the first avatar to use

avatar2stringOptional

Optional ID of the second avatar to use

subtitlesbooleanOptional

Optional boolean to include subtitles (default: true)

callbackDatastringOptional

Optional data to include in webhooks

scheduledOnstring ยท date-timeOptional

Optional date/time to schedule the request for processing

Responses
chevron-right
200

Request accepted

application/json
requestIdstringOptional

Request identifier

statusintegerOptional

Initial status code (0 = pending)

post
/video/CreateShorts

Create shorts from text

post

Create short videos from text content or feeds

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
contentstringOptional

Text content to create shorts from (optional if feedIds provided)

feedIdsstring[]Optional

Array of feed IDs to generate content from (optional if content provided)

promptstringOptional

Optional instructions for short creation

avatar1stringRequired

ID of the first avatar to use

avatar2stringOptional

Optional ID of the second avatar to use

subtitlesbooleanOptional

Optional boolean to include subtitles (default: true)

callbackDatastringOptional

Optional data to include in webhooks

scheduledOnstring ยท date-timeOptional

Optional date/time to schedule the request for processing

Responses
chevron-right
200

Request accepted

application/json
requestIdstringOptional

Request identifier

statusintegerOptional

Initial status code (0 = pending)

post
/video/CreateShortsFromContent

Create shorts from script

post

Create short videos from a custom script with avatar dialogue or from feeds

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
feedIdsstring[]Optional

Array of feed IDs to generate content from (optional if script provided)

subtitlesbooleanOptional

Optional boolean to include subtitles (default: true)

callbackDatastringOptional

Optional data to include in webhooks

scheduledOnstring ยท date-timeOptional

Optional date/time to schedule the request for processing

Responses
chevron-right
200

Request accepted

application/json
requestIdstringOptional

Request identifier

statusintegerOptional

Initial status code (0 = pending)

post
/video/CreateShortsFromScript

Create shorts from deep research

post

Create short videos from the results of a completed deep research

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
deepResearchIdstringRequired

ID of the completed deep research to create shorts from

promptstringOptional

Optional instructions for short creation

avatar1stringRequired

ID of the first avatar to use

avatar2stringOptional

Optional ID of the second avatar to use

subtitlesbooleanOptional

Optional boolean to include subtitles (default: true)

callbackDatastringOptional

Optional data to include in webhooks

scheduledOnstring ยท date-timeOptional

Optional date/time to schedule the request for processing

Responses
chevron-right
200

Request accepted

application/json
requestIdstringOptional

Request identifier

statusintegerOptional

Initial status code (0 = pending)

post
/video/CreateShortsFromDeepResearch

Create avatar

post

Create a new talking head avatar from text or image

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired

Name for the avatar

imageUrlstringOptional

Optional URL to an image to use as the base for the avatar

promptstringOptional

Optional text prompt describing the avatar (used when imageUrl is not provided)

voiceIdintegerOptional

Optional ID of the voice to use for the avatar

callbackDatastringOptional

Optional data to include in webhooks

scheduledOnstring ยท date-timeOptional

Optional date/time to schedule the request for processing

Responses
chevron-right
200

Request accepted

application/json
requestIdstringOptional

Request identifier

statusintegerOptional

Initial status code (0 = pending)

post
/video/CreateAvatar

Update avatar voice

post

Update the voice assigned to an existing avatar

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
avatarIdintegerRequired

ID of the avatar to update

voiceIdintegerRequired

ID of the new voice to assign to the avatar

Responses
chevron-right
200

Avatar voice updated successfully

application/json
successbooleanOptional

Success status

messagestringOptional

Success message

post
/video/UpdateAvatarVoice

Get explainer videos

get

List all explainer videos for the authenticated user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful response

application/json
idstringOptional

Video explainer identifier (matches request ID)

titlestringOptional

Title of the explainer video

descriptionstringOptional

Description of the explainer video

videoUrlstringOptional

URL to the explainer video

fileSizeintegerOptional

Size of the video file in bytes

durationSecondsintegerOptional

Duration of the video in seconds

shareUrlstringOptional

Shareable public URL for the video

createdOnstring ยท date-timeOptional

Creation date of the explainer video

requestedOnstring ยท date-timeOptional

Request creation date

succeededOnstring ยท date-timeOptional

Completion date

statusintegerOptional

Status code (100 = completed)

errorOnstring ยท date-timeOptional

Error occurrence date (if applicable)

errorMessagestringOptional

Error message (if applicable)

callbackDatastringOptional

Custom callback data

scheduledOnstring ยท date-timeOptional

Scheduled processing time (if applicable)

get
/video/GetExplainerVideos

Transcribe an explainer video

post

Submit a transcription job for an explainer video by ID

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
videoIdstringRequired

Explainer video ID (request ID)

Responses
chevron-right
200

Transcription request accepted

application/json
request_idstringOptional
statusintegerOptional
post
/video/Transcribe

Get an explainer transcript

get

Retrieve the transcript for a completed explainer video

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
videoIdstringRequired

Explainer video ID (request ID)

Responses
chevron-right
200

Transcript retrieved successfully

application/json
videoIdstringOptional

Explainer video identifier (request ID)

createdOnstring ยท date-timeOptional

Transcript creation timestamp

get
/video/Transcript/{videoId}

Generate branded intro image

get

Generate the branded intro image used for explainer videos and download the PNG asset.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
titlestringRequired

Title text rendered on the intro image.

subtitlestringOptional

Optional subtitle text displayed beneath the title.

logoUrlstringOptional

Optional logo URL to render on the intro image.

heroImageUrlstringOptional

Optional hero/background image URL composited into the intro artwork.

Responses
chevron-right
200

PNG image download containing the branded intro artwork.

image/png
Responsestring ยท binary
get
/video/GenerateIntroImage

Last updated