Models
The objects the requests send and the responses return. A field marked required must be sent; a response carries every field of its object, except where a field's description says when it is left out.
ApiError
object
codestringmessagestring
ApiKeyDto
object
idstring (uuid)namestringprefixstringcreatedAtstring (date-time)lastUsedAtstring (date-time) or nullexpiresAtstring (date-time) or nullcreatedBystring or nullcreatorLeftboolean
AudioTrack
object
pathstringrequiredoffsetSecondsnumberDefault
0
BlobKind
string
One of composition json image video audio font model
CompletedPart
object
partNumberintegerrequiredetagstring or nullrequired
CompleteUploadRequest
object
partsarray of CompletedPart or null
CompositionDto
object
widthintegerheightintegerframeRatenumberdurationSecondsnumberframeCountinteger
CompositionFontDto
object
namestringfamilystringstylestringsourceFontSourceOne of
projectlibrarymissing
CreateProblemReportRequest
object
messagestring or nullrequiredrenderIdstring (uuid) or nullversionIdstring (uuid) or null
CreateProjectRequest
object
namestringrequiredzipUploadIdstring (uuid) or nullfromVersionIdstring (uuid) or nullfontLicenseAcceptedbooleanDefault
false
CreateRenderArchiveRequest
object
renderIdsarray of string (uuid) or nullrequirednamestring or null
CreateRenderBatchRequest
object
versionIdstring (uuid) or nullrendersarray of RenderBatchItem or nullvariationstring or null
CreateRenderRequest
object
projectIdstring (uuid) or nullversionIdstring (uuid) or nullformatRenderFormatOne of
mp4hlsframesqualityRenderQualityOne of
lowmediumhighextraHighframesFrameRange or nullaudioAudioTrack or nullnamestring or nullreplacementsarray of Replacement or nullvariationstring or nullcodecVideoCodecOne of
h264hevcav1encodingRenderEncoding or nullEncoder settings a render asks for; without them its quality level sets a variable bitrate.
CreateUploadRequest
object
fileNamestringrequiredsizeBytesinteger (int64)required
CreateVariationRequest
object
namestringrequiredfromVersionIdstring (uuid) or nullfromVariationstring or null
CreateWebhookRequest
object
urlstringrequiredeventsarray of WebhookEventType or nullEach one of
render.succeededrender.failedrender.cancelleddownload_archive.readydownload_archive.failedversion_export.readyversion_export.failedbalance.lowwebhook.testdescriptionstring or null
EditFile
object
pathstringrequiredcontentstring or nullcontentBase64string or nulluploadIdstring (uuid) or nullfromVersionIdstring (uuid) or nullfromPathstring or null
EditProjectRequest
object
expectedHeadVersionIdstring (uuid) or nullmessagestring or nullfilesarray of EditFile or nulldeletearray of string or nullrestoreFromVersionIdstring (uuid) or nullnamestring or nullfontLicenseAcceptedbooleanDefault
falsesoundtrackAudioTrack or nulltextFittingBaselineVersionIdstring (uuid) or nullreplacementsarray of Replacement or nullvariationstring or null
ErrorResponse
object
errorApiError
FileCapabilitiesDto
object
uploadUploadCapabilitiesmaxFilesPerVersionintegermaxInlineEditBytesinteger (int64)compositionPathstringtextFittingPathstringfilesarray of FileTypeCapability
FileDto
object
pathstringsizeBytesinteger (int64)contentTypestringsha256string
FileTypeCapability
object
extensionstringkindBlobKindOne of
compositionjsonimagevideoaudiofontmodelcontentTypestringmaxSizeBytesinteger (int64)defaultFolderstringmaxWidthinteger or nullmaxHeightinteger or nullmaxDurationSecondsnumber or nullfontLicenseRequiredboolean
FontDeclaration
object
fNamestringfFamilystringfStylestring
FontDto
object
familystringstylestringslugstringdeclarationFontDeclarationlicenseFontLicense or nullOne of
oflapacheuflpreviewUrlstring or null
FontLicense
string
One of ofl apache ufl
FontSource
string
One of project library missing
FrameFormat
string
One of png jpeg tga
Default png
FrameRange
object
startintegerrequiredendintegerrequiredformatFrameFormatOne of
pngjpegtgaDefault
png
H264Profile
string
One of baseline main high
HtmlAdDto
object
urlstring
HtmlAdInteraction
string
One of video tapToContinue
HtmlAdPlatform
string
One of generic googleCampaignManager360 googleDisplayVideo360 theTradeDesk adform appLovin unityAds googleAppCampaigns meta tikTok pangle mintegral moloco liftoff
ImportPackageRequest
object
zipUploadIdstring (uuid) or nullrequiredexpectedHeadVersionIdstring (uuid) or nullfontLicenseAcceptedbooleanDefault
falsevariationstring or null
LayersDto
object
widthintegerheightintegertextLayersarray of TextLayerDtoimageLayersarray of MediaLayerDtovideoLayersarray of MediaLayerDtofontsarray of CompositionFontDtoaudioFilesarray of stringsoundtrackAudioTrack or null
MediaFit
string
One of contain cover
MediaLayerDto
object
layerstringnamestring or nullassetIdstringpathstring or nullwidthintegerheightinteger
MultipartDto
object
partSizeinteger (int64)partCountintegerurlsExpireAtstring (date-time)partsarray of UploadPartDto
PageOfApiKeyDto
object
itemsarray of ApiKeyDtonextstring or null
PageOfFontDto
object
itemsarray of FontDtonextstring or null
PageOfProjectDto
object
itemsarray of ProjectDtonextstring or null
PageOfProjectFileDto
object
itemsarray of ProjectFileDtonextstring or null
PageOfRenderDto
object
itemsarray of RenderDtonextstring or null
PageOfVariationDto
object
itemsarray of VariationDtonextstring or null
PageOfVersionDto
object
itemsarray of VersionDtonextstring or null
PageOfWebhookDeliveryDto
object
itemsarray of WebhookDeliveryDtonextstring or null
PageOfWebhookDto
object
itemsarray of WebhookDtonextstring or null
PlanLimitsDto
object
maxDurationSecondsinteger or nullmaxLongEdgeinteger or nullmaxShortEdgeinteger or nullwatermarkbooleanrequestsPerMinuteintegercustombooleancustomUntilstring (date-time) or nullmaxStorageBytesinteger (int64) or nullmaxProjectBytesinteger (int64) or nullmonthlyDownloadBytesinteger (int64) or nullshareLinksbooleanadvancedEncodingbooleanpriorityRenderingboolean
PlaybackState
string
One of preparing streaming complete
ProblemReportDto
object
idstring (uuid)renderIdstring (uuid) or nullversionIdstring (uuid) or nullmessagestringstatusProblemReportStatusOne of
openresolvedcreatedAtstring (date-time)resolvedAtstring (date-time) or nullresolutionstring or null
ProblemReportStatus
string
One of open resolved
ProjectDto
object
idstring (uuid)namestringcreatedAtstring (date-time)headVersionIdstring (uuid) or nullrenderableboolean or nullcopiedFromVersionIdstring (uuid) or nullthumbnailUrlstring or null
ProjectFileDto
object
pathstringkindBlobKindOne of
compositionjsonimagevideoaudiofontmodelsizeBytesinteger (int64)contentTypestringsha256stringversionIdstring (uuid)versionNumberinteger
RateControl
string
One of quality vbr cbr
RecoverWebhookRequest
object
sincestring (date-time) or null
RenameRequest
object
namestringrequired
RenderArchiveDto
object
idstring (uuid)statusRenderArchiveStatusOne of
queuedbuildingreadyfailedrenderIdsarray of string (uuid)fileNamestringurlstring or nullsizeBytesinteger (int64) or nullerrorApiError or nullcreatedAtstring (date-time)finishedAtstring (date-time) or nullexpiresAtstring (date-time)
RenderArchiveStatus
string
One of queued building ready failed
RenderBatchDto
object
versionIdstring (uuid)rendersarray of RenderDto
RenderBatchItem
object
formatRenderFormatOne of
mp4hlsframesqualityRenderQualityOne of
lowmediumhighextraHighframesFrameRange or nullaudioAudioTrack or nullnamestring or nullreplacementsarray of Replacement or nullcodecVideoCodecOne of
h264hevcav1encodingRenderEncoding or nullEncoder settings a render asks for; without them its quality level sets a variable bitrate.
RenderBulkDto
object
rendersarray of RenderDtonotFoundarray of string (uuid)
RenderDto
object
idstring (uuid)projectIdstring (uuid)versionIdstring (uuid) or nullsourceVersionIdstring (uuid)formatRenderFormatOne of
mp4hlsframesqualityRenderQualityOne of
lowmediumhighextraHighframesFrameRange or nullaudioAudioTrack or nullstatusRenderStatusOne of
queuedrenderingsucceededfailedcancellederrorApiError or nullchargedSecondsinteger (int64)refundedSecondsinteger (int64)createdAtstring (date-time)startedAtstring (date-time) or nullfinishedAtstring (date-time) or nulloutputRenderOutputDto or nullnamestring or nullplaybackPlaybackState or nullOne of
preparingstreamingcompletereplacementsarray of Replacement or nullThe replacements the render was created with. Left out unless one render is read: only the answer to creating a render and
GET /v1/renders/{renderId}carry it, and only for a render with replacements.codecVideoCodec or nullOne of
h264hevcav1encodingRenderEncoding or nullEncoder settings a render asks for; without them its quality level sets a variable bitrate.
RenderEncoding
object
Encoder settings a render asks for; without them its quality level sets a variable bitrate.
rateControlRateControlOne of
qualityvbrcbrbitrateKbpsinteger or nullmaxBitrateKbpsinteger or nullkeyframeIntervalSecondsnumber or nullh264ProfileH264Profile or nullOne of
baselinemainhigh
RenderFormat
string
One of mp4 hls frames
RenderIdsRequest
object
renderIdsarray of string (uuid) or nullrequired
RenderOutputDto
object
mp4Urlstring or nullhlsUrlstring or nullframeUrlsarray of string or nullexpiresAtstring (date-time)posterUrlstring or null
RenderQuality
string
One of low medium high extraHigh
RenderStatus
string
One of queued rendering succeeded failed cancelled
Replacement
object
RotateWebhookSecretRequest
object
gracePeriodSecondsinteger or null
TextLayerDto
object
layerstringnamestring or nulltextstringfontstring or nullfontSizenumber or nulltextFitboolean
UpdateWebhookRequest
object
urlstring or nulleventsarray of WebhookEventType or nullEach one of
render.succeededrender.failedrender.cancelleddownload_archive.readydownload_archive.failedversion_export.readyversion_export.failedbalance.lowwebhook.testenabledboolean or nulldescriptionstring or nullallEventsboolean or null
UploadCapabilities
object
maxSizeBytesinteger (int64)singlePutMaxBytesinteger (int64)multipartPartSizeBytesinteger (int64)singleUploadLifetimeSecondsintegermultipartUploadLifetimeSecondsintegerpartUrlLifetimeSecondsinteger
UploadDto
object
idstring (uuid)statusUploadStatusOne of
openprocessingreadyfailedurlstring or nullmethodstring or nullexpiresAtstring (date-time)multipartMultipartDto or nullerrorApiError or null
UploadPartDto
object
partNumberintegerurlstring
UploadPartsRequest
object
partNumbersarray of integer or null
UploadStatus
string
One of open processing ready failed
UsageDto
object
planstringrenderSecondsRemaininginteger (int64)monthlyRenderSecondsinteger (int64)periodEndsAtstring (date-time)trialbooleanplanEndedbooleannoTrialbooleanlimitsPlanLimitsDtostorageBytesinteger (int64)downloadBytesinteger (int64)
VariationDto
object
namestringheadVersionIdstring (uuid) or nullcreatedAtstring (date-time)
VersionDto
object
idstring (uuid)projectIdstring (uuid)parentVersionIdstring (uuid) or nullnumberintegermessagestringcreatedAtstring (date-time)compositionCompositionDto or nullrenderablebooleanproblemsarray of stringwarningsarray of stringsoundtrackAudioTrack or nulltextFittingBaselineVersionIdstring (uuid) or nullfilesarray of FileDto or nullnamestring or null
VersionExportDto
object
idstring (uuid)versionIdstring (uuid)statusVersionExportStatusOne of
queuedbuildingreadyfailedfileNamestringurlstring or nullsizeBytesinteger (int64) or nullerrorApiError or nullcreatedAtstring (date-time)finishedAtstring (date-time) or nullexpiresAtstring (date-time)
VersionExportStatus
string
One of queued building ready failed
VideoCodec
string
One of h264 hevc av1
WebhookDeliveryDto
object
idstring (uuid)messageIdstring (uuid)eventTypeWebhookEventTypeOne of
render.succeededrender.failedrender.cancelleddownload_archive.readydownload_archive.failedversion_export.readyversion_export.failedbalance.lowwebhook.teststatusWebhookDeliveryStatusOne of
pendingdeliveredfailedattemptsintegerlastStatusCodeinteger or nulllastErrorstring or nulllastResponsestring or nullcreatedAtstring (date-time)lastAttemptAtstring (date-time) or nullnextAttemptAtstring (date-time) or nulldeliveredAtstring (date-time) or null
WebhookDeliveryStatus
string
One of pending delivered failed
WebhookDto
object
idstring (uuid)urlstringdescriptionstring or nullallEventsbooleaneventsarray of WebhookEventTypeEach one of
render.succeededrender.failedrender.cancelleddownload_archive.readydownload_archive.failedversion_export.readyversion_export.failedbalance.lowwebhook.testenabledbooleandisabledReasonstring or nulldisabledAtstring (date-time) or nullpreviousSecretExpiresAtstring (date-time) or nullcreatedAtstring (date-time)secretstring or null
WebhookEventType
string
One of render.succeeded render.failed render.cancelled download_archive.ready download_archive.failed version_export.ready version_export.failed balance.low webhook.test
WebhookRecoveryDto
object
queuedinteger
WebhookSecretDto
object
secretstringpreviousSecretExpiresAtstring (date-time) or null
ZipCapabilities
object
maxFilesintegermaxUncompressedBytesinteger (int64)maxCompressionRatiointeger
ZipImportDto
object
idstring (uuid)projectIdstring (uuid)statusZipImportStatusOne of
queuedimportingsucceededfailedversionIdstring (uuid) or nullerrorApiError or nullcreatedAtstring (date-time)finishedAtstring (date-time) or null
ZipImportStatus
string
One of queued importing succeeded failed