API Reference

Files

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get File

client.files.retrieve(stringfileID, FileRetrieveParams { expand, organization_id, project_id } query?, RequestOptionsoptions?): FileRetrieveResponse { id, name, project_id, 6 more }

GET/api/v1/beta/files/{file_id}

Get file metadata by ID.

ParametersExpand Collapse

fileID: string

query: FileRetrieveParams { expand, organization_id, project_id }

expand?: Array<string> | null

Fields to expand.

organization_id?: string | null

project_id?: string | null

ReturnsExpand Collapse

FileRetrieveResponse { id, name, project_id, 6 more }

An uploaded file.

id: string

Unique file identifier

name: string

File name including extension

maxLength3000

minLength1

project_id: string

Project this file belongs to

formatuuid

download_url?: PresignedURL { expires_at, url, form_fields } | null

Schema for a presigned URL.

expires_at: string

The time at which the presigned URL expires

formatdate-time

url: string

A presigned URL for IO operations against a private file

formaturi

minLength1

form_fields?: Record<string, string> | null

Form fields for a presigned POST request

expires_at?: string | null

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

formatdate-time

external_file_id?: string | null

Optional ID for correlating with an external system

file_type?: string | null

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

maxLength3000

minLength1

last_modified_at?: string | null

When the file was last modified (ISO 8601)

formatdate-time

purpose?: string | null

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

Get File

TypeScript

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(file.id);

200 example

{
  "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "invoice.pdf",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "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

200 example

{
  "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "invoice.pdf",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "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"
}