Skip to content
Sign in with Google

Upload a file

POST
/v1/files

The raw bytes of any file type, up to 25 MiB; Content-Type is recorded as declared. Attach the returned ID to an input. Same key and bytes return the same file; different bytes are 409 idempotency_conflict. 411 length_required without Content-Length, 413 file_too_large over 25 MiB, 409 file_quota_exceeded when the upload quota is full.

Authorizations

Parameters

Header Parameters

Idempotency-Key
required
string
/^[A-Za-z0-9_-]{1,128}$/
Content-Length
required
integer
<= 26214400
Content-Disposition
string
Example
attachment; filename*=UTF-8''extrato-mar%C3%A7o.pdf

The file name, as filename*=UTF-8''<percent-encoded> or filename="<ASCII>". Without it: upload.

Request Body required

string

Responses

201

Success

An immutable private copy of a file, kept for 30 days. Only its owner can read or download it.

object
id
required
string
origin
required

Uploaded by the user, or published by the agent. Open: upload | publish.

string
sessionId

The session that published it. Absent on uploads, which belong to the user.

string
name
required
string
mediaType
required

Published: the allowlisted type for its name. Uploaded: as declared by the uploader, unverified. Downloads always use the allowlisted type for the name; anything else is application/octet-stream.

string
size
required

Bytes.

number
sha256
required

Hex SHA-256 of the content.

string
createdAt
required

Milliseconds since the epoch, as a string.

string
/^\d+$/
createdBy
required
string
expiresAt
required

When the stored copy is deleted, 30 days after creation. Then downloads are 410 file_gone.

string
/^\d+$/

400

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

401

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

403

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

404

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

409

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

410

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

411

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

413

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string

503

Rejected; never contains credentials or upstream payloads.

object
error
required
object
code
required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string
type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string
message
string