Skip to main content
POST
video.render.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by video.avatar.render, video.template.render or a row of video.renders.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
includeFile
boolean
default:false

Copy the finished video into file storage, up to 25 MB. Default false.

Response

The result

status
enum<string>
required

Current rendering state.

Available options:
queued,
processing,
complete,
failed,
rejected,
deleted
name
string

Video name.

Maximum string length: 512
description
string

Video description; may contain personal text.

Maximum string length: 2000
createdAt
string

Creation time in UTC.

updatedAt
string

Last change time in UTC.

durationSeconds
number

Finished video duration in seconds.

Required range: x >= 0
visibility
enum<string>

Whether the video is publicly shared.

Available options:
private,
public
test
boolean

Whether this is a watermarked test video.

file
object

Stored video file, requested with includeFile.