API reference

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

  • codestring
  • messagestring

ApiKeyDto

object

  • idstring (uuid)
  • namestring
  • prefixstring
  • createdAtstring (date-time)
  • lastUsedAtstring (date-time) or null
  • expiresAtstring (date-time) or null
  • createdBystring or null
  • creatorLeftboolean

AudioTrack

object

  • pathstringrequired
  • offsetSecondsnumber

    Default 0

BlobKind

string

One of composition json image video audio font model

CompletedPart

object

  • partNumberintegerrequired
  • etagstring or nullrequired

CompleteUploadRequest

object

CompositionDto

object

  • widthinteger
  • heightinteger
  • frameRatenumber
  • durationSecondsnumber
  • frameCountinteger

CompositionFontDto

object

  • namestring
  • familystring
  • stylestring
  • One of project library missing

CreateProblemReportRequest

object

  • messagestring or nullrequired
  • renderIdstring (uuid) or null
  • versionIdstring (uuid) or null

CreateProjectRequest

object

  • namestringrequired
  • zipUploadIdstring (uuid) or null
  • fromVersionIdstring (uuid) or null
  • fontLicenseAcceptedboolean

    Default false

CreateRenderArchiveRequest

object

  • renderIdsarray of string (uuid) or nullrequired
  • namestring or null

CreateRenderBatchRequest

object

  • versionIdstring (uuid) or null
  • rendersarray of RenderBatchItem or null
  • variationstring or null

CreateRenderRequest

object

  • projectIdstring (uuid) or null
  • versionIdstring (uuid) or null
  • One of mp4 hls frames

  • One of low medium high extraHigh

  • framesFrameRange or null
  • audioAudioTrack or null
  • namestring or null
  • replacementsarray of Replacement or null
  • variationstring or null
  • One of h264 hevc av1

  • encodingRenderEncoding or null

    Encoder settings a render asks for; without them its quality level sets a variable bitrate.

CreateShareLinkRequest

object

  • One of low medium high extraHigh

  • versionIdstring (uuid) or null
  • variationstring or null

CreateUploadRequest

object

  • fileNamestringrequired
  • sizeBytesinteger (int64)required

CreateVariationRequest

object

  • namestringrequired
  • fromVersionIdstring (uuid) or null
  • fromVariationstring or null

CreateWebhookRequest

object

  • urlstringrequired
  • eventsarray of WebhookEventType or null

    Each one of render.succeeded render.failed render.cancelled download_archive.ready download_archive.failed version_export.ready version_export.failed balance.low webhook.test

  • descriptionstring or null

EditFile

object

  • pathstringrequired
  • contentstring or null
  • contentBase64string or null
  • uploadIdstring (uuid) or null
  • fromVersionIdstring (uuid) or null
  • fromPathstring or null

EditProjectRequest

object

  • expectedHeadVersionIdstring (uuid) or null
  • messagestring or null
  • filesarray of EditFile or null
  • deletearray of string or null
  • restoreFromVersionIdstring (uuid) or null
  • namestring or null
  • fontLicenseAcceptedboolean

    Default false

  • soundtrackAudioTrack or null
  • textFittingBaselineVersionIdstring (uuid) or null
  • replacementsarray of Replacement or null
  • variationstring or null

ErrorResponse

object

FileCapabilitiesDto

object

FileDto

object

  • pathstring
  • sizeBytesinteger (int64)
  • contentTypestring
  • sha256string

FileTypeCapability

object

  • extensionstring
  • One of composition json image video audio font model

  • contentTypestring
  • maxSizeBytesinteger (int64)
  • defaultFolderstring
  • maxWidthinteger or null
  • maxHeightinteger or null
  • maxDurationSecondsnumber or null
  • fontLicenseRequiredboolean

FontDeclaration

object

  • fNamestring
  • fFamilystring
  • fStylestring

FontDto

object

  • familystring
  • stylestring
  • slugstring
  • declarationFontDeclaration
  • licenseFontLicense or null

    One of ofl apache ufl

  • previewUrlstring 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

  • startintegerrequired
  • endintegerrequired
  • One of png jpeg tga

    Default 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 nullrequired
  • expectedHeadVersionIdstring (uuid) or null
  • fontLicenseAcceptedboolean

    Default false

  • variationstring or null

LayersDto

object

MediaFit

string

One of contain cover

MediaLayerDto

object

  • layerstring
  • namestring or null
  • assetIdstring
  • pathstring or null
  • widthinteger
  • heightinteger

MultipartDto

object

  • partSizeinteger (int64)
  • partCountinteger
  • urlsExpireAtstring (date-time)
  • partsarray of UploadPartDto

PageOfApiKeyDto

object

PageOfFontDto

object

  • itemsarray of FontDto
  • nextstring or null

PageOfProjectDto

object

PageOfProjectFileDto

object

PageOfRenderDto

object

PageOfShareLinkDto

object

PageOfVariationDto

object

PageOfVersionDto

object

PageOfWebhookDeliveryDto

object

PageOfWebhookDto

object

PlanLimitsDto

object

  • maxDurationSecondsinteger or null
  • maxLongEdgeinteger or null
  • maxShortEdgeinteger or null
  • watermarkboolean
  • requestsPerMinuteinteger
  • customboolean
  • customUntilstring (date-time) or null
  • maxStorageBytesinteger (int64) or null
  • maxProjectBytesinteger (int64) or null
  • monthlyDownloadBytesinteger (int64) or null
  • shareLinksboolean
  • advancedEncodingboolean
  • priorityRenderingboolean

PlaybackState

string

One of preparing streaming complete

ProblemReportDto

object

  • idstring (uuid)
  • renderIdstring (uuid) or null
  • versionIdstring (uuid) or null
  • messagestring
  • One of open resolved

  • createdAtstring (date-time)
  • resolvedAtstring (date-time) or null
  • resolutionstring or null

ProblemReportStatus

string

One of open resolved

ProjectDto

object

  • idstring (uuid)
  • namestring
  • createdAtstring (date-time)
  • headVersionIdstring (uuid) or null
  • renderableboolean or null
  • copiedFromVersionIdstring (uuid) or null
  • thumbnailUrlstring or null

ProjectFileDto

object

  • pathstring
  • One of composition json image video audio font model

  • sizeBytesinteger (int64)
  • contentTypestring
  • sha256string
  • versionIdstring (uuid)
  • versionNumberinteger

RateControl

string

One of quality vbr cbr

RecoverWebhookRequest

object

  • sincestring (date-time) or null

RenameRequest

object

  • namestringrequired

RenderArchiveDto

object

  • idstring (uuid)
  • One of queued building ready failed

  • renderIdsarray of string (uuid)
  • fileNamestring
  • urlstring or null
  • sizeBytesinteger (int64) or null
  • errorApiError or null
  • createdAtstring (date-time)
  • finishedAtstring (date-time) or null
  • expiresAtstring (date-time)

RenderArchiveStatus

string

One of queued building ready failed

RenderBatchDto

object

  • versionIdstring (uuid)
  • rendersarray of RenderDto

RenderBatchItem

object

RenderBulkDto

object

  • rendersarray of RenderDto
  • notFoundarray of string (uuid)

RenderDto

object

  • idstring (uuid)
  • projectIdstring (uuid)
  • versionIdstring (uuid) or null
  • sourceVersionIdstring (uuid)
  • One of mp4 hls frames

  • One of low medium high extraHigh

  • framesFrameRange or null
  • audioAudioTrack or null
  • One of queued rendering succeeded failed cancelled

  • errorApiError or null
  • chargedSecondsinteger (int64)
  • refundedSecondsinteger (int64)
  • createdAtstring (date-time)
  • startedAtstring (date-time) or null
  • finishedAtstring (date-time) or null
  • outputRenderOutputDto or null
  • namestring or null
  • playbackPlaybackState or null

    One of preparing streaming complete

  • replacementsarray of Replacement or null

    The 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 null

    One of h264 hevc av1

  • encodingRenderEncoding or null

    Encoder 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.

  • rateControlRateControl

    One of quality vbr cbr

  • bitrateKbpsinteger or null
  • maxBitrateKbpsinteger or null
  • keyframeIntervalSecondsnumber or null
  • h264ProfileH264Profile or null

    One of baseline main high

RenderFormat

string

One of mp4 hls frames

RenderIdsRequest

object

  • renderIdsarray of string (uuid) or nullrequired

RenderOutputDto

object

  • mp4Urlstring or null
  • hlsUrlstring or null
  • frameUrlsarray of string or null
  • expiresAtstring (date-time)
  • posterUrlstring or null

RenderQuality

string

One of low medium high extraHigh

RenderStatus

string

One of queued rendering succeeded failed cancelled

Replacement

object

  • layerstringrequired
  • textstring or null
  • fontstring or null
  • pathstring or null
  • fileEditFile or null
  • fitMediaFit or null

    One of contain cover

RotateWebhookSecretRequest

object

  • gracePeriodSecondsinteger or null

ShareLinkDto

object

  • idstring
  • projectIdstring (uuid)
  • versionIdstring (uuid) or null
  • variationstring or null
  • One of low medium high extraHigh

  • urlstring
  • createdAtstring (date-time)

TextLayerDto

object

  • layerstring
  • namestring or null
  • textstring
  • fontstring or null
  • fontSizenumber or null
  • textFitboolean

UpdateWebhookRequest

object

  • urlstring or null
  • eventsarray of WebhookEventType or null

    Each one of render.succeeded render.failed render.cancelled download_archive.ready download_archive.failed version_export.ready version_export.failed balance.low webhook.test

  • enabledboolean or null
  • descriptionstring or null
  • allEventsboolean or null

UploadCapabilities

object

  • maxSizeBytesinteger (int64)
  • singlePutMaxBytesinteger (int64)
  • multipartPartSizeBytesinteger (int64)
  • singleUploadLifetimeSecondsinteger
  • multipartUploadLifetimeSecondsinteger
  • partUrlLifetimeSecondsinteger

UploadDto

object

  • idstring (uuid)
  • One of open processing ready failed

  • urlstring or null
  • methodstring or null
  • expiresAtstring (date-time)
  • multipartMultipartDto or null
  • errorApiError or null

UploadPartDto

object

  • partNumberinteger
  • urlstring

UploadPartsRequest

object

  • partNumbersarray of integer or null

UploadStatus

string

One of open processing ready failed

UsageDto

object

  • planstring
  • renderSecondsRemaininginteger (int64)
  • monthlyRenderSecondsinteger (int64)
  • periodEndsAtstring (date-time)
  • trialboolean
  • planEndedboolean
  • noTrialboolean
  • storageBytesinteger (int64)
  • downloadBytesinteger (int64)

VariationDto

object

  • namestring
  • headVersionIdstring (uuid) or null
  • createdAtstring (date-time)

VersionDto

object

  • idstring (uuid)
  • projectIdstring (uuid)
  • parentVersionIdstring (uuid) or null
  • numberinteger
  • messagestring
  • createdAtstring (date-time)
  • compositionCompositionDto or null
  • renderableboolean
  • problemsarray of string
  • warningsarray of string
  • soundtrackAudioTrack or null
  • textFittingBaselineVersionIdstring (uuid) or null
  • filesarray of FileDto or null
  • namestring or null

VersionExportDto

object

  • idstring (uuid)
  • versionIdstring (uuid)
  • One of queued building ready failed

  • fileNamestring
  • urlstring or null
  • sizeBytesinteger (int64) or null
  • errorApiError or null
  • createdAtstring (date-time)
  • finishedAtstring (date-time) or null
  • expiresAtstring (date-time)

VersionExportStatus

string

One of queued building ready failed

VideoCodec

string

One of h264 hevc av1

WebhookDeliveryDto

object

  • idstring (uuid)
  • messageIdstring (uuid)
  • One of render.succeeded render.failed render.cancelled download_archive.ready download_archive.failed version_export.ready version_export.failed balance.low webhook.test

  • One of pending delivered failed

  • attemptsinteger
  • lastStatusCodeinteger or null
  • lastErrorstring or null
  • lastResponsestring or null
  • createdAtstring (date-time)
  • lastAttemptAtstring (date-time) or null
  • nextAttemptAtstring (date-time) or null
  • deliveredAtstring (date-time) or null

WebhookDeliveryStatus

string

One of pending delivered failed

WebhookDto

object

  • idstring (uuid)
  • urlstring
  • descriptionstring or null
  • allEventsboolean
  • eventsarray of WebhookEventType

    Each one of render.succeeded render.failed render.cancelled download_archive.ready download_archive.failed version_export.ready version_export.failed balance.low webhook.test

  • enabledboolean
  • disabledReasonstring or null
  • disabledAtstring (date-time) or null
  • previousSecretExpiresAtstring (date-time) or null
  • createdAtstring (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

  • secretstring
  • previousSecretExpiresAtstring (date-time) or null

ZipCapabilities

object

  • maxFilesinteger
  • maxUncompressedBytesinteger (int64)
  • maxCompressionRatiointeger

ZipImportDto

object

  • idstring (uuid)
  • projectIdstring (uuid)
  • One of queued importing succeeded failed

  • versionIdstring (uuid) or null
  • errorApiError or null
  • createdAtstring (date-time)
  • finishedAtstring (date-time) or null

ZipImportStatus

string

One of queued importing succeeded failed