Skip to main content
POST
Request a signed upload URL

Authorizations

X-Api-Key
string
header
required

API key created in the web app under API keys. Expired or disabled keys are rejected with 401.

Body

application/json
fileName
string
required

Name of the file to upload, including its extension.

fileSize
number

File size in bytes, checked against the size limit for its media type.

originUI
boolean

Ignored by the API.

showAudioResult
boolean

For video, also analyze the extracted audio. Defaults to the organization setting.

contentPreview
string

Text preview for text uploads.

tags
string[]

Labels to attach to the scan.

Minimum array length: 1
Required string length: 1 - 128

Response

Signed upload URL and the request ID of the new scan

code
string
required

ok on success.

response
object
required
errno
number
required

0 on success.

mediaId
string
required

Same value as requestId.

requestId
string
required

ID used to fetch the result from GET /api/media/users/{requestId}.