Upload File

Upload a file using multipart/form-data.

Set purpose to indicate how the file will be used: user_data, parse, extract, classify, split, sheet, or agent_app.

Returns the created file metadata including its ID for use in subsequent parse, extract, or classify operations.

post/api/v1/beta/files

Query parameters

project_idstring uuid nullable

organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring required

Unique file identifier

namestring required

File name including extension

external_file_idstring nullable

Optional ID for correlating with an external system

file_typestring nullable

File extension (pdf, docx, png, etc.)

project_idstring uuid required

Project this file belongs to

last_modified_atstring date-time nullable

When the file was last modified (ISO 8601)

expires_atstring date-time nullable

When the file expires and may be automatically removed. Null means no expiration.

purposestring nullable

How the file will be used: user_data, parse, extract, classify, split, sheet, or agent_app

Example response

{
  "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "invoice.pdf",
  "external_file_id": "ext-12345",
  "file_type": "pdf",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "purpose": "parse"
}

Changes

Changed in 7 of the 33 revisions of this API.26

Jun 9, 2026b17341164de92See the full diff
- ○
  added the optional property detail/items/ctx to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property detail/items/input to the response with the 422 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 23, 202634da5826db1c1See the full diff
- ○
  added the optional property download_url to the response with the 201 status
  response-optional-property-added
May 21, 2026fb63fb8d662c1See the full diff
- ●
  removed the optional property download_url from the response with the 201 status
  response-optional-property-removed
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 16, 2026c317ed7c691a1See the full diff
- ○
  added the optional property download_url to the response with the 201 status
  response-optional-property-added
May 14, 20261bbc901f8c0d1See the full diff
- ●
  removed the optional property download_url from the response with the 201 status
  response-optional-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 12, 2026548a0c57fdd61See the full diff
- ○
  added the optional property download_url to the response with the 201 status
  response-optional-property-added
Apr 24, 20261bbc901f8c0d1See the full diff
- ○
  api tag Files added
  api-tag-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history