API Reference

Files

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get File

FileRetrieveResponse files().retrieve(FileRetrieveParamsparams = FileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Get file metadata by ID.

ParametersExpand Collapse

FileRetrieveParams params

Optional<String> fileId

Optional<List<String>> expand

Fields to expand.

Optional<String> organizationId

Optional<String> projectId

ReturnsExpand Collapse

class FileRetrieveResponse:

An uploaded file.

String id

Unique file identifier

String name

File name including extension

maxLength3000

minLength1

String projectId

Project this file belongs to

formatuuid

Optional<PresignedUrl> downloadUrl

Schema for a presigned URL.

LocalDateTime expiresAt

The time at which the presigned URL expires

formatdate-time

String url

A presigned URL for IO operations against a private file

formaturi

minLength1

Optional<FormFields> formFields

Form fields for a presigned POST request

Optional<LocalDateTime> expiresAt

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

formatdate-time

Optional<String> externalFileId

Optional ID for correlating with an external system

Optional<String> fileType

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

maxLength3000

minLength1

Optional<LocalDateTime> lastModifiedAt

When the file was last modified (ISO 8601)

formatdate-time

Optional<String> purpose

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

Get File

Java

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.files.FileRetrieveParams;
import ai.llamaindex.llamacloud.models.files.FileRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        FileRetrieveResponse file = client.files().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}

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