Skip to main content
POST
video.reframe

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
prompt
string
required

How to fill the newly exposed area, 1 to 6000 characters.

Required string length: 1 - 6000
aspect
enum<string>
required

New frame shape.

Available options:
9:16,
3:4,
1:1,
4:3,
16:9,
21:9
fileId
string

Id of an uploaded file holding the source video, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
url
string

Public video link; send exactly one of url or fileId.

durationSeconds

Requested output length, 5 or 10 seconds. Sources that preserve input duration decline this option.

resolution
enum<string>

Output resolution. Explicit 1080p can cost up to 3.60 USD for ten seconds.

Available options:
360p,
540p,
720p,
1080p
quality
enum<string>
default:fast

Rendering quality for sources with several models; defaults to fast.

Available options:
fast,
best
sourcePosition
object

Normalized placement in the new canvas; availability depends on the source.

geometry
object

Pixel and grid placement where supported; all supplied fields are honored or the source declines.

guideFileId
string

Id of an uploaded file holding an optional first-frame image guide, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
guideUrl
string

Public first-frame guide image; use this or guideFileId.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.