List Directories

client.beta.directories.list(?, ?): PaginatedCursor<DirectoryListResponse { id, name, project_id, 5 more } >

GET/api/v1/beta/directories

List Directories

ParametersExpand Collapse

query: DirectoryListParams { data_source_id, include_deleted, name, 4 more }

data_source_id?: string | null

include_deleted?: boolean

name?: string | null

organization_id?: string | null

page_size?: number | null

page_token?: string | null

project_id?: string | null

ReturnsExpand Collapse

DirectoryListResponse { id, name, project_id, 5 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?: string | null

Creation datetime

formatdate-time

data_source_id?: string | null

Optional data source id the directory syncs from. Null if just manual uploads.

deleted_at?: string | null

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

formatdate-time

description?: string | null

Optional description shown to users.

updated_at?: string | null

Update datetime

formatdate-time

List Directories

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const directoryListResponse of client.beta.directories.list()) {
  console.log(directoryListResponse.id);
}

{
  "items": [
    {
      "id": "id",
      "name": "x",
      "project_id": "project_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "data_source_id": "data_source_id",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "name": "x",
      "project_id": "project_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "data_source_id": "data_source_id",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}