Skip to content
Developer Documentation
API Reference
Beta

Directories

Create Directory
POST/api/v1/beta/directories
List Directories
GET/api/v1/beta/directories
Get Directory
GET/api/v1/beta/directories/{directory_id}
Update Directory
PATCH/api/v1/beta/directories/{directory_id}
Delete Directory
DELETE/api/v1/beta/directories/{directory_id}
ModelsExpand Collapse
DirectoryCreateResponse = object { id, name, project_id, 7 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1
project_id: string

Project the directory belongs to.

created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
description: optional string

Optional description shown to users.

expires_at: optional string

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: optional map[unknown]

Reserved system-managed metadata.

type: optional "user" or "index" or "ephemeral"

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

One of the following:
"user"
"index"
"ephemeral"
updated_at: optional string

Update datetime

formatdate-time
DirectoryListResponse = object { id, name, project_id, 7 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1
project_id: string

Project the directory belongs to.

created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
description: optional string

Optional description shown to users.

expires_at: optional string

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: optional map[unknown]

Reserved system-managed metadata.

type: optional "user" or "index" or "ephemeral"

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

One of the following:
"user"
"index"
"ephemeral"
updated_at: optional string

Update datetime

formatdate-time
DirectoryGetResponse = object { id, name, project_id, 7 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1
project_id: string

Project the directory belongs to.

created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
description: optional string

Optional description shown to users.

expires_at: optional string

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: optional map[unknown]

Reserved system-managed metadata.

type: optional "user" or "index" or "ephemeral"

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

One of the following:
"user"
"index"
"ephemeral"
updated_at: optional string

Update datetime

formatdate-time
DirectoryUpdateResponse = object { id, name, project_id, 7 more }

API response schema for a directory.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

minLength1
project_id: string

Project the directory belongs to.

created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
description: optional string

Optional description shown to users.

expires_at: optional string

When this directory expires and is eligible for cleanup.

formatdate-time
system_metadata: optional map[unknown]

Reserved system-managed metadata.

type: optional "user" or "index" or "ephemeral"

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

One of the following:
"user"
"index"
"ephemeral"
updated_at: optional string

Update datetime

formatdate-time

DirectoriesFiles

Add Directory File
POST/api/v1/beta/directories/{directory_id}/files
List Directory Files
GET/api/v1/beta/directories/{directory_id}/files
Get Directory File
GET/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Update Directory File
PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Delete Directory File
DELETE/api/v1/beta/directories/{directory_id}/files/{directory_file_id}
Upload File To Directory
POST/api/v1/beta/directories/{directory_id}/files/upload
ModelsExpand Collapse
FileAddResponse = object { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1
project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1
created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
download_url: optional PresignedURL { expires_at, url, form_fields }

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

minLength1
formaturi
form_fields: optional map[string]

Form fields for a presigned POST request

file_id: optional string

File ID for the storage location.

metadata: optional map[string or number or number or 3 more]

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

One of the following:
string
number
number
boolean
unknown
MetadataListValue = array of string
updated_at: optional string

Update datetime

formatdate-time
FileListResponse = object { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1
project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1
created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
download_url: optional PresignedURL { expires_at, url, form_fields }

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

minLength1
formaturi
form_fields: optional map[string]

Form fields for a presigned POST request

file_id: optional string

File ID for the storage location.

metadata: optional map[string or number or number or 3 more]

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

One of the following:
string
number
number
boolean
unknown
MetadataListValue = array of string
updated_at: optional string

Update datetime

formatdate-time
FileGetResponse = object { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1
project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1
created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
download_url: optional PresignedURL { expires_at, url, form_fields }

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

minLength1
formaturi
form_fields: optional map[string]

Form fields for a presigned POST request

file_id: optional string

File ID for the storage location.

metadata: optional map[string or number or number or 3 more]

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

One of the following:
string
number
number
boolean
unknown
MetadataListValue = array of string
updated_at: optional string

Update datetime

formatdate-time
FileUpdateResponse = object { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1
project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1
created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
download_url: optional PresignedURL { expires_at, url, form_fields }

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

minLength1
formaturi
form_fields: optional map[string]

Form fields for a presigned POST request

file_id: optional string

File ID for the storage location.

metadata: optional map[string or number or number or 3 more]

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

One of the following:
string
number
number
boolean
unknown
MetadataListValue = array of string
updated_at: optional string

Update datetime

formatdate-time
FileUploadResponse = object { id, directory_id, display_name, 8 more }

API response schema for a directory file.

id: string

Unique identifier for the directory file.

directory_id: string

Directory the file belongs to.

display_name: string

Display name for the file.

minLength1
project_id: string

Project the directory file belongs to.

unique_id: string

Unique identifier for the file in the directory

minLength1
created_at: optional string

Creation datetime

formatdate-time
deleted_at: optional string

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

formatdate-time
download_url: optional PresignedURL { expires_at, url, form_fields }

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

minLength1
formaturi
form_fields: optional map[string]

Form fields for a presigned POST request

file_id: optional string

File ID for the storage location.

metadata: optional map[string or number or number or 3 more]

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

One of the following:
string
number
number
boolean
unknown
MetadataListValue = array of string
updated_at: optional string

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/