Skip to main content
POST

Authorizations

Authorization
string
header
required

rk_live_… or rk_test_…, made in Reedapt under Developers.

Headers

idempotency-key
string | null

Any unique string, up to 255 characters. Sending the same request again with the same key returns the first answer instead of doing the work twice. Kept for 24 hours.

Example:

"7c1f6a52-2d4e-4bb1-9e0a-5f3d8c2b1a90"

Body

application/json
filename
string | null

The file's name, with its extension. With source_url, only if the link doesn't end in one.

Required string length: 1 - 255
Example:

"interview.mp4"

size
integer | null

The file's size in bytes (not with source_url).

Required range: x > 0
Example:

734003200

source_url
string | null

A public http(s) link to the file. We download it ourselves; poll the upload until it is uploaded.

Maximum string length: 2048
Example:

"https://example.com/media/interview.mp4"

Response

Successful Response

id
string
required

The upload's id. Its dubs are created from it.

Example:

"job_3f9a2c7e1b4d"

filename
string
required
Example:

"interview.mp4"

size
integer
required

In bytes. 0 while a source_url is still downloading.

Example:

734003200

status
enum<string>
required

uploading: waiting for its parts. fetching: we're downloading source_url. uploaded: ready to dub. used: already dubbed. failed: see error.

Available options:
uploading,
fetching,
uploaded,
used,
failed
Example:

"uploading"

part_size
integer
required

Every part but the last is exactly this many bytes.

Example:

16777216

part_count
integer
required
Example:

44

object
string
default:upload
Allowed value: "upload"
error
string | null

Why a fetch from source_url failed.

parts
PartLink · object[]

Signed links for the first parts. Ask for the rest with /parts.

parts_expire_at
string<date-time> | null

When the links in parts stop working (15 minutes).