API REFERENCE · SCHEMA

UploadIntent schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

idRequired
string

Format: uuid.

pathnameRequired
string
accessRequired
"private"

Must equal "private".

handleUploadUrlRequired
"/api/v1/uploads"

Must equal "/api/v1/uploads".

maxBytesRequired
integer

Minimum: 0.

reservedBytesRequired
integer

Minimum: 0.

formatRequired
string

Use UploadIntent in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides