Upload File

POST/api/v1/beta/files

Upload a file using multipart/form-data.

ParametersExpand Collapse

The file to upload

formatbinary

purpose: str

The intended purpose of the file. Valid values: 'user_data', 'parse', 'extract', 'split', 'classify', 'sheet', 'agent_app'

organization_id: Optional[str]

project_id: Optional[str]

external_file_id: Optional[str]

The ID of the file in the external system

ReturnsExpand Collapse

class FileCreateResponse: …

Schema for a file in the v2 API.

id: str

Unique identifier

name: str

project_id: str

The ID of the project that the file belongs to

formatuuid

expires_at: Optional[datetime]

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

formatdate-time

external_file_id: Optional[str]

The ID of the file in the external system

file_type: Optional[str]

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

maxLength3000

minLength1

last_modified_at: Optional[datetime]

The last modified time of the file

formatdate-time

purpose: Optional[str]

The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify', 'sheet', 'agent_app')

Upload File

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
file = client.files.create(
    file=b"raw file contents",
    purpose="purpose",
)
print(file.id)

{
  "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"
}