Skip to main content
POST
Create a Ditto video

Authorizations

Authorization
string
header
required

A Melius API key (mel_...), sent as Authorization: Bearer <key>.

x-team-id
string
header
required

The team (workspace) to act on. Defaults to the key's team when omitted.

Headers

idempotency-key
string

A case-sensitive key for one intended submission: 1–255 ASCII letters, digits, periods, underscores, colons or hyphens. Reuse it for identical retries; use a fresh key for a new run.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json

Body

sourceAssetId
string<uuid>
required
dittoTemplate
object
styleId
string<uuid>

A Ditto style to re-render the whole source video in. Send no replacements with it.

additionalInstructions
string
Maximum string length: 2000
sourceRange
object
modelId
string
Required string length: 1 - 100
resolution
enum<string>
Available options:
480p,
720p,
1080p,
480P,
768P,
1080P
audioMode
enum<string>
default:original
Available options:
original,
mute
replacements
object[]

What to replace, in order: each item names an image or an avatar. Leave it out for a style transfer or an edit described only in additionalInstructions.

Maximum array length: 30
maxCredits
number

The most credits this video may cost. A higher price answers 402 and starts nothing.

Required range: x >= 0

Response

202

generationId
string<uuid>
required
status
enum<string>
required
Available options:
preparing,
rendering,
finalizing,
ready,
failed
input
object
required
canvasId
string<uuid>
required
sourceVideoUrl
string | null
required
referenceImageUrl
string | null
required
url
string
required
bulkNodeRunId
string<uuid>
outputVersionId
string<uuid>
outputAssetId
string<uuid>
videoUrl
string | null
references
object[]
canRetryFinalization
boolean
retryQuoteId
string
failureMessage
string
gemsReturned
integer
Required range: x > 0
credits
object
failureReason
enum<string>
Available options:
insufficient_credits,
content_policy,
no_media_generated,
provider_error,
validation_error,
timeout,
system,
unknown
estimatedWait
object
retryOf
string<uuid>