Retrieve a video job

Retrieve the status and details of a video using its UUID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authentication

Authorization: <YOUR_API_KEY>


Path Parameter

ParameterTypeRequiredDescription
video_uuidstringYesUUID of the video you created

Response

FieldTypeDescription
uuidstringUnique ID of the video
projectstringUUID of the project this video belongs to.
statusstringOne of: queued, in_progress, complete, error
video_urlstringFinal stitched video URL
orientationstringlandscape or portrait
resolutionstring720p or 1080p
ai_enginestringv24 or v25
video_clipsarray of VideoClip[]List of individual clips per video
brandingobjectPresent only if branding was requested when the video was created. Tracks the separate branded render - see Branding object below.

Example response

{
  "uuid": "9734b67c-54c6-454d-8874-120063af4a07",
  "project": "b1f2c3d4-5678-4abc-9def-0123456789ab",
  "status": "queued",
  "video_url": "",
  "video_clips": [],
  "resolution": "720p",
  "orientation": "landscape",
  "ai_engine": "v25",
  "branding": {
    "status": "queued",
    "video_url": "",
    "templates": {
      "intro": {
        "template": "gold-frame",
        "config": {
          "title": { "value": "Just Listed" },
          "subtitle": { "value": "$650,000" }
        }
      },
      "outro": {
        "template": "classic",
        "config": {
          "outro_text": { "value": "Jane Doe\n(415) 555-0137" },
          "brand_logo": { "url": "https://example.com/logo.png" }
        }
      }
    }
  }
}

VideoClip object

FieldTypeDescription
uuidstringUUID of the video clip
clip_urlstringURL of the generated video clip
image_urlstringURL of the source image for that clip
camera_motionstringpush-in, push-out, orbit-left, orbit-right, auto
orientationstringlandscape or portrait
resolutionstring720p or 1080p
ai_enginestringv24 or v25
vfxobject|nullThe VFX applied to that clip, e.g. {"type": "word-drop", "config": {"text": "FOR SALE", "color": "gold"}}, or null if none

Branding

FieldTypeDescription
statusstringStatus of the branded render. One of queued, in_progress, complete, or error. This is independent of the top-level video status.
video_urlstringURL of the branded video. Empty until status is complete. The branded render typically finishes a few minutes after the top-level video_url is available. Poll this same GET /get_video endpoint to retrieve the updated URL.
templatesobjectEchoes the intro/outro template configuration provided when the video was created.

Path Params
uuid
required

UUID of the video

Responses

404

Video not found or not owned by user

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json