API Reference

Beta

Directories

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Directories

$ llamacloud-prod beta:directories list

GET/api/v1/beta/directories

List Directories

ParametersExpand Collapse

--include-deleted: optional boolean

Include deleted directories.

--name: optional string

Directory name to match.

--organization-id: optional string

--page-size: optional number

--page-token: optional string

--project-id: optional string

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

Directory type to include.

--type: optional array of "user" or "index" or "ephemeral"

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

ReturnsExpand Collapse

DirectoryQueryResponse: object { items, next_page_token, total_size }

API query response schema for directories.

items: array of object { id, name, project_id, 7 more }

The list of items.

id: string

Unique identifier for the directory.

name: string

Human-readable name for the directory.

project_id: string

Project the directory belongs to.

created_at: optional string

Creation datetime

deleted_at: optional string

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

description: optional string

Optional description shown to users.

expires_at: optional string

When this directory expires and is eligible for cleanup.

system_metadata: optional map[unknown]

Reserved system-managed metadata.

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

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

"user"

"index"

"ephemeral"

updated_at: optional string

Update datetime

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Directories

CLI Tool

HTTP

TypeScript

Python

Java

Go

CLI Tool

llamacloud-prod beta:directories list \
  --api-key 'My API Key'

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
}