Create media upload session

POST

/media/upload-session

Create a media asset and return the worker upload URL the client should PUT bytes to. Call /:mediaId/process once the PUT completes.

Authorizations

• bearerAuth

Request Body ^required

object

kind

required

string

Allowed values: File Directory

scope

string

Allowed values: Collection User

fileName

required

string

>= 1 characters

mimeType

required

string

>= 1 characters

fileSize

required

integer

> 0 <= 9007199254740991

Responses

200

Upload session

object

media

required

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

accountId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

required

string

Allowed values: File Directory

scope

required

string

Allowed values: Collection User

provenance

required

string

Allowed values: UserUpload SystemGenerated

status

required

string

Allowed values: Pending Processing Ready Failed

fileName

required

string

mimeType

required

Any of:

string

string

null

null

fileSize

required

Any of:

integer

integer

<= 9007199254740991

null

null

contentHash

required

Any of:

string

string

null

null

parentId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

path

required

Any of:

string

string

null

null

uploadedAt

required

Any of:

string

string

null

null

locations

required

Array<object>

object

id

required

string

mediaId

required

string

provider

required

string

Allowed values: R2 Arweave S3 IPFS

role

required

string

Allowed values: Origin Archive Mirror

reference

required

string

status

required

string

Allowed values: Pending Succeeded Failed

attempts

required

integer

<= 9007199254740991

lastError

required

Any of:

string

string

null

null

syncedAt

required

Any of:

string

string

null

null

metadata

required

Any of:

object

object

key

additional properties

null

null

createdAt

required

string

updatedAt

required

string

url

required

Any of:

string

string format: uri

null

null

createdAt

required

string

updatedAt

required

string

upload

required

object

url

required

string format: uri

method

required

string

Allowed value: PUT

headers

required

object

key

additional properties

string

400

Invalid request

401

Unauthorized

403

Forbidden

503

Storage unavailable