API Reference

Files

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get File

files.retrieve(strfile_id, FileRetrieveParams**kwargs) -> FileRetrieveResponse

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

Get file metadata by ID.

ParametersExpand Collapse

file_id: str

expand: Optional[Sequence[str]]

Fields to expand.

organization_id: Optional[str]

project_id: Optional[str]

ReturnsExpand Collapse

class FileRetrieveResponse: …

An uploaded file.

id: str

Unique file identifier

name: str

File name including extension

maxLength3000

minLength1

project_id: str

Project this file belongs to

formatuuid

download_url: Optional[PresignedURL]

Schema for a presigned URL.

expires_at: datetime

The time at which the presigned URL expires

formatdate-time

url: str

A presigned URL for IO operations against a private file

formaturi

minLength1

form_fields: Optional[Dict[str, str]]

Form fields for a presigned POST request

expires_at: Optional[datetime]

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

formatdate-time

external_file_id: Optional[str]

Optional ID for correlating with an external system

file_type: Optional[str]

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

maxLength3000

minLength1

last_modified_at: Optional[datetime]

When the file was last modified (ISO 8601)

formatdate-time

purpose: Optional[str]

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

Get File

Python

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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.retrieve(
    file_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(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"
}