Get Directory

beta.directories.get(, ) -> DirectoryGetResponse

GET/api/v1/beta/directories/{directory_id}

Retrieve a directory by its identifier.

ParametersExpand Collapse

directory_id: str

organization_id: Optional[str]

project_id: Optional[str]

ReturnsExpand Collapse

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

data_source_id: Optional[str]

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

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.

updated_at: Optional[datetime]

Update datetime

formatdate-time

Get Directory

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
)
directory = client.beta.directories.get(
    directory_id="directory_id",
)
print(directory.id)

{
  "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"
}

Returns Examples

{
  "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"
}