Skip to main content
Uploads are sent as multipart/form-data to dedicated endpoints. Unlike the JSON REST API, these routes live at the root host, not under /api/v1:
Every upload uses the same Authorization: Bearer YOUR_API_KEY header as the rest of the API, and the file must be sent as a multipart form field named filepond.

Example

POST /fileupload uploads a file for an attachment field; write the returned url to that field via Create Record or Update Record.

Endpoints

s3Key is the storage key the import flow uses to reference the uploaded file.

Attachment size limits

The largest attachment you can upload depends on your plan: A file over the limit returns 413 Payload Too Large.

Large attachments

POST /fileupload carries at most 99 MB in one request. For a larger file, upload it straight to storage in three steps. Both JSON calls take the same base-public-id, table-id, and field-id headers as /fileupload:
  1. POST /attachment-upload-session with { "filename", "sizeBytes", "mimeType" }. It returns { presignedUrl, s3Key, contentType }.
  2. PUT the raw file bytes to presignedUrl with a Content-Type header set to the returned contentType.
  3. POST /attachment-upload-complete with { "s3Key" }. It returns the same { url, fileName, size, mimeType } shape as /fileupload.
SVG, HTML, JavaScript, and XML files can’t use this flow and must go through /fileupload.

Validation

Errors from these endpoints (other than a missing or invalid API key) have the shape { "statusCode", "error", "message" }. A request that fails any of these returns 400 Bad Request: