Skip to content
Developer Documentation
API Reference
Beta

Directories

Create Directory
beta.directories.create(DirectoryCreateParams**kwargs) -> DirectoryCreateResponse
POST/api/v1/beta/directories
List Directories
beta.directories.list(DirectoryListParams**kwargs) -> SyncPaginatedCursor[DirectoryListResponse]
GET/api/v1/beta/directories
Get Directory
beta.directories.get(strdirectory_id, DirectoryGetParams**kwargs) -> DirectoryGetResponse
GET/api/v1/beta/directories/{directory_id}
Update Directory
beta.directories.update(strdirectory_id, DirectoryUpdateParams**kwargs) -> DirectoryUpdateResponse
PATCH/api/v1/beta/directories/{directory_id}
Delete Directory
beta.directories.delete(strdirectory_id, DirectoryDeleteParams**kwargs)
DELETE/api/v1/beta/directories/{directory_id}
ModelsExpand Collapse
class DirectoryCreateResponse: …

API response schema for a directory.

id: str

Unique identifier for the directory.

name: str

Human-readable name for the directory.

minLength1
project_id: str

Project the directory belongs to.

created_at: Optional[datetime]

Creation datetime

formatdate-time
deleted_at: Optional[datetime]

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time
description: Optional[str]

Optional description shown to users.

expires_at: Optional[datetime]

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: Optional[Dict[str, object]]

Reserved system-managed metadata.

type: Optional[Literal["user", "index", "ephemeral"]]

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:
"user"
"index"
"ephemeral"
updated_at: Optional[datetime]

Update datetime

formatdate-time
class DirectoryListResponse: …

API response schema for a directory.

id: str

Unique identifier for the directory.

name: str

Human-readable name for the directory.

minLength1
project_id: str

Project the directory belongs to.

created_at: Optional[datetime]

Creation datetime

formatdate-time
deleted_at: Optional[datetime]

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time
description: Optional[str]

Optional description shown to users.

expires_at: Optional[datetime]

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: Optional[Dict[str, object]]

Reserved system-managed metadata.

type: Optional[Literal["user", "index", "ephemeral"]]

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:
"user"
"index"
"ephemeral"
updated_at: Optional[datetime]

Update datetime

formatdate-time
class DirectoryGetResponse: …

API response schema for a directory.

id: str

Unique identifier for the directory.

name: str

Human-readable name for the directory.

minLength1
project_id: str

Project the directory belongs to.

created_at: Optional[datetime]

Creation datetime

formatdate-time
deleted_at: Optional[datetime]

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time
description: Optional[str]

Optional description shown to users.

expires_at: Optional[datetime]

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: Optional[Dict[str, object]]

Reserved system-managed metadata.

type: Optional[Literal["user", "index", "ephemeral"]]

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:
"user"
"index"
"ephemeral"
updated_at: Optional[datetime]

Update datetime

formatdate-time
class DirectoryUpdateResponse: …

API response schema for a directory.

id: str

Unique identifier for the directory.

name: str

Human-readable name for the directory.

minLength1
project_id: str

Project the directory belongs to.

created_at: Optional[datetime]

Creation datetime

formatdate-time
deleted_at: Optional[datetime]

Optional timestamp of when the directory was deleted. Null if not deleted.

formatdate-time
description: Optional[str]

Optional description shown to users.

expires_at: Optional[datetime]

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: Optional[Dict[str, object]]

Reserved system-managed metadata.

type: Optional[Literal["user", "index", "ephemeral"]]

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:
"user"
"index"
"ephemeral"
updated_at: Optional[datetime]

Update datetime

formatdate-time

DirectoriesFiles

Add Directory File
beta.directories.files.add(strdirectory_id, FileAddParams**kwargs) -> FileAddResponse
POST/api/v1/beta/directories/{directory_id}/files
List Directory Files
beta.directories.files.list(strdirectory_id, FileListParams**kwargs) -> SyncPaginatedCursor[FileListResponse]
GET/api/v1/beta/directories/{directory_id}/files
Get Directory File
beta.directories.files.get(strdirectory_file_id, FileGetParams**kwargs) -> FileGetResponse
GET/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Update Directory File
beta.directories.files.update(strdirectory_file_id, FileUpdateParams**kwargs) -> FileUpdateResponse
PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Delete Directory File
beta.directories.files.delete(strdirectory_file_id, FileDeleteParams**kwargs)
DELETE/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Upload File To Directory
beta.directories.files.upload(strdirectory_id, FileUploadParams**kwargs) -> FileUploadResponse
POST/api/v1/beta/directories/{directory_id}/files/upload
ModelsExpand 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

minLength1
formaturi
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
class FileListResponse: …

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

minLength1
formaturi
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
class FileGetResponse: …

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

minLength1
formaturi
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
class FileUpdateResponse: …

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

minLength1
formaturi
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
class FileUploadResponse: …

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

minLength1
formaturi
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
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/