Skip to content

Create Directory

$ llamacloud-prod beta:directories create
POST/api/v1/beta/directories

Create a new directory within the specified project.

If data_source_id is provided, validates that the data source exists and belongs to the same project.

ParametersExpand Collapse
--name: string

Body param: Human-readable name for the directory.

--organization-id: optional string

Query param

--project-id: optional string

Query param

--data-source-id: optional string

Body param: Optional data source id the directory syncs from.

--description: optional string

Body param: Optional description shown to users.

ReturnsExpand Collapse
BetaDirectoryNewResponse: object { 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.

project_id: string

Project the directory belongs to.

created_at: optional string

Creation datetime

data_source_id: optional string

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

deleted_at: optional string

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

description: optional string

Optional description shown to users.

updated_at: optional string

Update datetime

Create Directory

llamacloud-prod beta:directories create \
  --api-key 'My API Key' \
  --name x
{
  "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"
}