Project representation

cluster

string

required

The cluster on which the project is running.

clusterJobId

string

required

The unique identifier of the cluster job processing the project.

createdAt

string

required

The date and time when the project was created.

id

string

required

The unique identifier of the project.

isDeleted

boolean

required

Indicates whether the project is deleted.

isPurged

boolean

required

Indicates whether the project is purged.

labels

string[]

required

Labels associated with the project.

orgId

string

required

The unique identifier of the organization.

permissions

string[]

required

Permissions associated with the project.

productTier

string

required

The product tier of the project.

projectId

string

required

The unique identifier of the project.

promptRecommendations

string[]

required

Recommendations for project prompts.

sourceId

string

required

The unique identifier for the video on the source platform.

sourcePlatform

enum<string>

required

The platform from which the video is sourced.

Available options:

YOUTUBE,

UPLOADED,

YTDLP_LINK,

GDRIVE,

ZOOM,

STREAM_YARD

stage

enum<string>

required

The current stage of the project.

Available options:

PENDING,

QUEUED,

IMPORT,

CURATE,

REFINE,

RENDER,

UPLOAD,

COMPLETE,

STALLED

storageExpireAt

string

required

The expiration date of the project storage.

storageSize

number

required

The total size of the project in bytes.

storageStatus

string

required

The storage status of the project.

updatedAt

string

required

The date and time when the project was last updated.

userId

string

required

The unique identifier of the user.

visibility

enum<string>

required

The visibility of the project.

Available options:

DEFAULT,

PUBLIC,

PUBLIC_VIEW

curationPref

object

Preferences for advanced curation of the video.

error

string

Error message, if any.

importPref

object

Preferences for importing the video, such as source language.

refundStatus

string

The refund status of the project.

renderPref

object

Preferences for rendering the video, including layout and overlay options.

renderPref.enableAutoLayout

boolean

default:

false

required

Enables automatic layout adjustment.

renderPref.enableCaption

boolean

default:

false

required

Enables caption overlay on the video.

renderPref.enableCrop

boolean

default:

false

required

Enables cropping of the video.

renderPref.enableEmoji

boolean

default:

false

required

Enables emoji overlay on the video.

renderPref.enableFillLayout

boolean

default:

false

required

Enables fill layout for a single person.

renderPref.enableFitLayout

boolean

default:

false

required

Enables fit layout for multiple people.

renderPref.enableFourLayout

boolean

default:

false

required

Enables layout for four people.

renderPref.enableHighlight

boolean

default:

false

required

Enables keyword highlighting in captions.

renderPref.enableScreenLayout

boolean

default:

false

required

Enables screen layout for the video.

renderPref.enableSplitLayout

boolean

default:

false

required

Enables split layout for two people.

renderPref.enableThreeLayout

boolean

default:

false

required

Enables layout for three people.

renderPref.enableUppercase

boolean

default:

false

required

Converts all characters to uppercase in captions.

renderPref.enableVisualHook

boolean

default:

false

required

Enables visual hook overlay, deprecated and should always be false.

renderPref.enableWatermark

boolean

default:

false

required

Enables watermark overlay.

renderPref.fitLayoutCropRatio

string

default:

4:3

required

Specifies the crop ratio for fit layout.

renderPref.font

object

required

Font settings for captions.

renderPref.highlightColor

object

required

Highlight colors for keywords in captions.

renderPref.enableBroll

boolean

default:

false

Enables B-Roll overlay on the video.

renderPref.layoutAspectRatio

enum<string>

default:

portrait

Specifies the layout aspect ratio.

Available options:

portrait,

landscape,

square

sourceUri

string

The URI of the source video.

stallCount

number

The number of times the project has stalled.

workerUrl

string

The URL of the worker processing the project.

GET STARTED

ENDPOINTS

PLAYGROUND

Project representation