Upload File

client.files.create(, ?): FileCreateResponse { id, name, project_id, 5 more }

POST/api/v1/beta/files

Upload a file using multipart/form-data.

ParametersExpand Collapse

params: FileCreateParams { file, purpose, organization_id, 2 more }

file: Uploadable

Body param: The file to upload

formatbinary

purpose: string

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

organization_id?: string | null

Query param

formatuuid

project_id?: string | null

Query param

formatuuid

external_file_id?: string | null

Body param: The ID of the file in the external system

ReturnsExpand Collapse

FileCreateResponse { id, name, project_id, 5 more }

Schema for a file in the v2 API.

id: string

Unique identifier

name: string

project_id: string

The ID of the project that the file belongs to

formatuuid

expires_at?: string | null

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

formatdate-time

external_file_id?: string | null

The ID of the file in the external system

file_type?: string | null

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

maxLength3000

minLength1

last_modified_at?: string | null

The last modified time of the file

formatdate-time

purpose?: string | null

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

Upload File

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const file = await client.files.create({
  file: fs.createReadStream('path/to/file'),
  purpose: 'purpose',
});

console.log(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"
}