Skip to main content
POST
Submit a render job

Authorizations

Authorization
string
header
required

API key as Authorization: Bearer sk-social-...

Path Parameters

clipId
string
required

Body

application/json
candidateId
string
required

ID of the candidate clip to render.

Example:

"cand_01"

template
string

Render template / style to apply.

Example:

"default"

captions
boolean
default:false

Whether to burn captions into the video. Default: false.

Example:

true

Response

Render job queued.

success
boolean
Example:

true

data
object