Upload File

POST/api/v1/beta/files

Upload a file using multipart/form-data.

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

id: string

Unique identifier

name: string

project_id: string

The ID of the project that the file belongs to

formatuuid

expires_at: optional string

The expiration date for the file. Files past this date can be deleted.

formatdate-time

external_file_id: optional string

The ID of the file in the external system

file_type: optional string

File type (e.g. pdf, docx, etc.)

maxLength3000

minLength1

last_modified_at: optional string

The last modified time of the file

formatdate-time

purpose: optional string

The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify', 'sheet', '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": "id",
  "name": "x",
  "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "external_file_id": "external_file_id",
  "file_type": "x",
  "last_modified_at": "2019-12-27T18:11:19.117Z",
  "purpose": "purpose"
}

Returns Examples

{
  "id": "id",
  "name": "x",
  "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "external_file_id": "external_file_id",
  "file_type": "x",
  "last_modified_at": "2019-12-27T18:11:19.117Z",
  "purpose": "purpose"
}