Beta
Directories

Get Directory

Changed on

Retrieve a directory by its identifier.

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

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/beta/directories/{directory_id}
  • Auth: HTTP bearer

Path parameters

directory_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring required

Unique identifier for the directory.

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project the directory belongs to.

namestring required

Human-readable name for the directory.

descriptionstring nullable

Optional description shown to users.

type'user' | 'index' | 'ephemeral' nullable

Directory type: 'user', 'index', or 'ephemeral'.

connector_subscription_idstring nullable

Connector Subscription whose files sync into this directory. Null for a directory populated by manual uploads.

expires_atstring date-time nullable

When this directory expires and is eligible for cleanup.

system_metadataobject nullable

Reserved system-managed metadata.

deleted_atstring date-time nullable

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

Example response

{
  "connector_subscription_id": "csub-abc123"
}

Changes

  • a38b684f8e1bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the system_ephemeral enum value from the / response property for the response status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status