Skip to main content
POST
Start upload

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Body

application/json
filename
string
required

Original filename, including its extension

Minimum string length: 1
etag
string
required

Required file ETag/hash. OFAuth uses this to check whether the media already exists before creating upload URLs.

Minimum string length: 1
size
integer
required

File size in bytes

Required range: x > 0
contentType
string
required

MIME type of the file (e.g., image/jpeg, video/mp4)

Minimum string length: 1

Response

Successful response

status
enum<string>
required
Available options:
needs_upload
uploadId
string
required
uploadType
enum<string>
required
Available options:
single,
multipart
totalParts
integer
required
Required range: x > 0
partSize
integer
required
Required range: x > 0
expiresAt
string
required
parts
object[]
required
completeUrl
string<uri>