API Reference

Beta

Directories

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Directories

beta.directories.list(DirectoryListParams**kwargs) -> SyncPaginatedCursor[DirectoryListResponse]

GET/api/v1/beta/directories

List Directories

ParametersExpand Collapse

include_deleted: Optional[bool]

Include deleted directories.

name: Optional[str]

Directory name to match.

organization_id: Optional[str]

page_size: Optional[int]

page_token: Optional[str]

project_id: Optional[str]

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

Directory type to include.

One of the following:

"user"

"index"

"ephemeral"

types: Optional[List[Literal["user", "index", "ephemeral"]]]

Filter by one or more directory types. Repeat the parameter for multiple values.

One of the following:

"user"

"index"

"ephemeral"

ReturnsExpand Collapse

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

List Directories

Python

HTTP

TypeScript

Python

Java

Go

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
)
page = client.beta.directories.list()
page = page.items[0]
print(page.id)

200 example

{
  "items": [
    {
      "id": "id",
      "name": "x",
      "project_id": "project_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "system_metadata": {
        "foo": "bar"
      },
      "type": "user",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "name": "x",
      "project_id": "project_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "system_metadata": {
        "foo": "bar"
      },
      "type": "user",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}