Skip to main content
POST
media.upload.create

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
fileId
string

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

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

Public https URL of the media file, in place of an uploaded file.

filename
string

File name to store it under, e.g. launch-video.mp4. Guessed when omitted.

Required string length: 1 - 255

Response

The result

contentType
string
required

Media type of the placed copy.

sizeBytes
number
required

Size of the placed copy in bytes.

file
object

The media as a platform file (for a url source): a signed link that serves the raw file and stops working at expiresAt.