Operations

Export a video

Per-request overrides layer on top of the video's settings and the Brand Kit (request > video > Brand Kit) and apply to this render only.

Scope: export:write

Role permission: canExport (OAuth only — API keys carry full workspace permissions)

post/v1/videos/{id}/export

Request

  • Base URL: https://api.vidocu.ai
  • URL: https://api.vidocu.ai/v1/videos/{id}/export
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://vidocu.ai/oauth/authorize, token URL https://api.vidocu.ai/oauth/token)

Path parameters

idstring required

Request body

languagestring
ratio'16:9' | '9:16' | '1:1' | '4:5' | '4:3'
openingSceneUrlstring uri nullable
closingSceneUrlstring uri nullable
zoomsboolean
elementsboolean
reframeboolean
slidesobject[]

Response

Job accepted; poll GET /v1/jobs/:id

jobIdstring required

Poll this via GET /v1/jobs/{id}.

status'pending' required

Changes

No recorded changes to this operation across all 1 revision of this API.