Beta
Directories

Create Directory

Changed on

Create a new directory within the specified project.

post/api/v1/beta/directories

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

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.

Example request

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

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' | '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.

Changes

  • b17341164de9Revision changes
    • info

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

    • info

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

  • 1c29e1491a38Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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