Videos API
4 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.
POST/v1/orgs/{orgId}/marketing/videos/branded
Starts rendering an uploaded video as a reel (1080×1920), portrait (1080×1350), square (1080×1080) or landscape (1920×1080) video with the brand's subtitles, progress bar and logo, name or handle. Returns the queued render; poll it for the finished video.
Path parameters
orgIdstring (uuid)required
Request body application/json
videoobjectrequiredFields
assetIdstring (uuid)required
brandingobjectFields
progressBarstringone of
none,bottom,borderprogressColorstring | nullsubtitlesobjectFields
enabledbooleanstylestringone of
highlight,boxed,cleanpositionstringone of
lower,middle
footerobjectFields
logobooleannamebooleanhandlestring | null
fitstringone of
blur,cropformatstringone of
reel,portrait,square,landscape
saveAsDefaultsbooleanlanguagestring
Responses
200Starts rendering an uploaded video as a reel (1080×1920), portrait (1080×1350), square (1080×1080) or landscape (1920×1080) video with the brand's subtitles, progress bar and logo, name or handle. Returns the queued render; poll it for the finished video.
dataobjectrequiredFields
idstringrequiredstatusstringrequiredone of
queued,rendering,done,failedstagestring | nullrequiredone of
preparing,transcribing,branding,finishingstageProgressnumber | nullrequiredsourceAssetIdstringrequiredbrandingobjectrequiredFields
progressBarstringrequiredone of
none,bottom,borderprogressColorstring | nullrequiredsubtitlesobjectrequiredFields
enabledbooleanrequiredstylestringrequiredone of
highlight,boxed,cleanpositionstringrequiredone of
lower,middle
footerobjectrequiredFields
logobooleanrequirednamebooleanrequiredhandlestring | nullrequired
fitstringrequiredone of
blur,cropformatstringone of
reel,portrait,square,landscape
postMediaobject | nullrequiredOption 1
kind"image"requiredassetIdstring (uuid)requiredurlstring (uri)requiredcontentTypestringrequiredsizeBytesintegerrequiredwidthintegerheightintegeraltTextstring
Option 2
kind"images"requiredimagesarray<object>requiredItem fields
assetIdstring (uuid)requiredurlstring (uri)requiredcontentTypestringrequiredsizeBytesintegerrequiredwidthintegerheightintegeraltTextstring
Option 3
kind"document"requiredassetIdstring (uuid)requiredurlstring (uri)requiredcontentType"application/pdf"requiredsizeBytesintegerrequiredtitlestringrequiredpageCountintegerpreviewImageUrlsarray<string (uri)>
Option 4
kind"video"requiredassetIdstring (uuid)requiredurlstring (uri)requiredcontentTypestringrequiredsizeBytesintegerrequireddurationSecondsnumberrequiredwidthintegerrequiredheightintegerrequired
captionsarray<object>requiredItem fields
textstringrequiredstartnumberrequiredendnumberrequired
errorstring | nullrequiredcreditsUsednumber | nullrequiredcreatedAtstringrequiredupdatedAtstringrequired
curl -X POST "https://api.deynix.com/v1/orgs/$ORG_ID/marketing/videos/branded" \ -H "Authorization: Bearer $DEYNIX_TOKEN" \ -H "Content-Type: application/json" \ -d '{"video":{"assetId":"3f8e2c1a-0000-4000-8000-000000000000"}}'GET/v1/orgs/{orgId}/marketing/videos/branded/{renderId}
A branded video render's status (queued, rendering, done or failed), its subtitles and, once done, the video to attach to a post.
Path parameters
orgIdstring (uuid)requiredrenderIdstring (uuid)required
Responses
200A branded video render's status (queued, rendering, done or failed), its subtitles and, once done, the video to attach to a post.
dataobjectrequiredFields
idstringrequiredstatusstringrequiredone of
queued,rendering,done,failedstagestring | nullrequiredone of
preparing,transcribing,branding,finishingstageProgressnumber | nullrequiredsourceAssetIdstringrequiredbrandingobjectrequiredFields
progressBarstringrequiredone of
none,bottom,borderprogressColorstring | nullrequiredsubtitlesobjectrequiredFields
enabledbooleanrequiredstylestringrequiredone of
highlight,boxed,cleanpositionstringrequiredone of
lower,middle
footerobjectrequiredFields
logobooleanrequirednamebooleanrequiredhandlestring | nullrequired
fitstringrequiredone of
blur,cropformatstringone of
reel,portrait,square,landscape
postMediaobject | nullrequiredOption 1
kind"image"requiredassetIdstring (uuid)requiredurlstring (uri)requiredcontentTypestringrequiredsizeBytesintegerrequiredwidthintegerheightintegeraltTextstring
Option 2
kind"images"requiredimagesarray<object>requiredItem fields
assetIdstring (uuid)requiredurlstring (uri)requiredcontentTypestringrequiredsizeBytesintegerrequiredwidthintegerheightintegeraltTextstring
Option 3
kind"document"requiredassetIdstring (uuid)requiredurlstring (uri)requiredcontentType"application/pdf"requiredsizeBytesintegerrequiredtitlestringrequiredpageCountintegerpreviewImageUrlsarray<string (uri)>
Option 4
kind"video"requiredassetIdstring (uuid)requiredurlstring (uri)requiredcontentTypestringrequiredsizeBytesintegerrequireddurationSecondsnumberrequiredwidthintegerrequiredheightintegerrequired
captionsarray<object>requiredItem fields
textstringrequiredstartnumberrequiredendnumberrequired
errorstring | nullrequiredcreditsUsednumber | nullrequiredcreatedAtstringrequiredupdatedAtstringrequired
curl -X GET "https://api.deynix.com/v1/orgs/$ORG_ID/marketing/videos/branded/$RENDER_ID" \ -H "Authorization: Bearer $DEYNIX_TOKEN"GET/v1/orgs/{orgId}/marketing/videos/defaults
The subtitle style, progress bar and footer branded reels use when a render doesn't choose its own.
Path parameters
orgIdstring (uuid)required
Responses
200The subtitle style, progress bar and footer branded reels use when a render doesn't choose its own.
dataobjectrequiredFields
brandingobjectrequiredFields
progressBarstringrequiredone of
none,bottom,borderprogressColorstring | nullrequiredsubtitlesobjectrequiredFields
enabledbooleanrequiredstylestringrequiredone of
highlight,boxed,cleanpositionstringrequiredone of
lower,middle
footerobjectrequiredFields
logobooleanrequirednamebooleanrequiredhandlestring | nullrequired
fitstringrequiredone of
blur,cropformatstringone of
reel,portrait,square,landscape
savedbooleanrequired
curl -X GET "https://api.deynix.com/v1/orgs/$ORG_ID/marketing/videos/defaults" \ -H "Authorization: Bearer $DEYNIX_TOKEN"PUT/v1/orgs/{orgId}/marketing/videos/defaults
Changes the defaults branded reels use. Only the fields sent change.
Path parameters
orgIdstring (uuid)required
Request body application/json
progressBarstringone of
none,bottom,borderprogressColorstring | nullsubtitlesobjectFields
enabledbooleanstylestringone of
highlight,boxed,cleanpositionstringone of
lower,middle
footerobjectFields
logobooleannamebooleanhandlestring | null
fitstringone of
blur,cropformatstringone of
reel,portrait,square,landscape
Responses
200Changes the defaults branded reels use. Only the fields sent change.
dataobjectrequiredFields
brandingobjectrequiredFields
progressBarstringrequiredone of
none,bottom,borderprogressColorstring | nullrequiredsubtitlesobjectrequiredFields
enabledbooleanrequiredstylestringrequiredone of
highlight,boxed,cleanpositionstringrequiredone of
lower,middle
footerobjectrequiredFields
logobooleanrequirednamebooleanrequiredhandlestring | nullrequired
fitstringrequiredone of
blur,cropformatstringone of
reel,portrait,square,landscape
savedbooleanrequired
curl -X PUT "https://api.deynix.com/v1/orgs/$ORG_ID/marketing/videos/defaults" \ -H "Authorization: Bearer $DEYNIX_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'
Social media marketing tools your AI assistant runs. Drafts in your voice, publishes only when you approve.