v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB

Beta

Directories

Create Directory

Create a new directory within the specified project.

post/api/v1/beta/directories

project_idstring uuid nullable

organization_idstring uuid nullable

sessionstring nullable

namestring required

Human-readable name for the directory.

descriptionstring nullable

Optional description shown to users.

type'user' | 'ephemeral'

Directory type. Use 'ephemeral' for batch processing with automatic cleanup.

expires_atstring date-time nullable

When this directory expires. Required for ephemeral directories.

system_metadataobject nullable

Reserved system-managed metadata.

{
  "type": "user",
  "expires_at": "2026-05-10T00:00:00Z"
}

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' | 'system_ephemeral' nullable

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

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.