API REFERENCE · SCHEMA

UploadTokenRequest 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.

typeRequired
"blob.generate-client-token"

Fixed client-token request discriminator.

Must equal "blob.generate-client-token".

payloadRequired
object

Provider client-token payload. Use the exact pathname from the authorized upload intent.

payload fields and rules
payload.pathnameRequired
string

Exact pathname from POST /uploads/intent; it is bound to your organization and key environment.

payload.clientPayloadRequired
string or null

Client metadata field used by the upload protocol. Send null when no metadata is needed.

May be null.

payload.clientPayload fields and rules

Allowed alternatives

  • string
  • null

    May be null.

payload.multipartRequired
false

Must be false: only a single bounded private upload is supported.

Must equal false.

Use UploadTokenRequest 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