Upload File

POST/api/v1/beta/files

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.

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersForm DataExpand Collapse

file: file

The file to upload

purpose: string

The intended purpose of the file. Valid values: 'user_data', 'parse', 'extract', 'split', 'classify', 'sheet', 'agent_app'. This determines the storage and retention policy for the file.

external_file_id: optional string

The ID of the file in the external system

ReturnsExpand Collapse

id: string

Unique file identifier

name: string

File name including extension

maxLength3000

minLength1

project_id: string

Project this file belongs to

formatuuid

expires_at: optional string

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

formatdate-time

external_file_id: optional string

Optional ID for correlating with an external system

file_type: optional string

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

maxLength3000

minLength1

last_modified_at: optional string

When the file was last modified (ISO 8601)

formatdate-time

purpose: optional string

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

Upload File

curl https://api.cloud.llamaindex.ai/api/v1/beta/files \
    -H 'Content-Type: multipart/form-data' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -F 'file=@/path/to/file' \
    -F purpose=purpose

{
  "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "invoice.pdf",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "external_file_id": "ext-12345",
  "file_type": "pdf",
  "last_modified_at": "2019-12-27T18:11:19.117Z",
  "purpose": "parse"
}

Returns Examples

{
  "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "invoice.pdf",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "external_file_id": "ext-12345",
  "file_type": "pdf",
  "last_modified_at": "2019-12-27T18:11:19.117Z",
  "purpose": "parse"
}