API Reference

Beta

Directories

Files

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Add Directory File

beta.directories.files.add(strdirectory_id, FileAddParams**kwargs) -> FileAddResponse

POST/api/v1/beta/directories/{directory_id}/files

Create a new file within the specified directory; the directory must exist in the project and file_id must reference an existing file.

ParametersExpand Collapse

directory_id: str

file_id: str

File ID for the storage location (required).

organization_id: Optional[str]

project_id: Optional[str]

display_name: Optional[str]

Display name for the file. If not provided, will use the file’s name.

metadata: Optional[Dict[str, Union[str, int, float, 3 more]]]

User-defined metadata key-value pairs to associate with the file.

One of the following:

str

int

float

bool

None

Sequence[str]

unique_id: Optional[str]

Unique identifier for the file in the directory. If not provided, will use the file’s external_file_id or name.

ReturnsExpand Collapse

class FileAddResponse: …

API response schema for a directory file.

id: str

Unique identifier for the directory file.

directory_id: str

Directory the file belongs to.

display_name: str

Display name for the file.

minLength1

project_id: str

Project the directory file belongs to.

unique_id: str

Unique identifier for the file in the directory

minLength1

created_at: Optional[datetime]

Creation datetime

formatdate-time

deleted_at: Optional[datetime]

Soft delete marker when the file is removed upstream or by user action.

formatdate-time

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

file_id: Optional[str]

File ID for the storage location.

metadata: Optional[Dict[str, Union[str, int, float, 3 more]]]

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:

str

int

float

bool

None

List[str]

updated_at: Optional[datetime]

Update datetime

formatdate-time

Add Directory File

Python

HTTP

TypeScript

Python

Go

Java

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
)
response = client.beta.directories.files.add(
    directory_id="directory_id",
    file_id="file_id",
)
print(response.id)

200 example

{
  "id": "id",
  "directory_id": "directory_id",
  "display_name": "x",
  "project_id": "project_id",
  "unique_id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "file_id": "file_id",
  "metadata": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "directory_id": "directory_id",
  "display_name": "x",
  "project_id": "project_id",
  "unique_id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "file_id": "file_id",
  "metadata": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}