API Reference

Beta

Directories

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update Directory

DirectoryUpdateResponse Beta.Directories.Update(DirectoryUpdateParamsparameters, CancellationTokencancellationToken = default)

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

Update directory metadata.

ParametersExpand Collapse

DirectoryUpdateParams parameters

required string directoryID

Path param

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

string? description

Body param: Updated description for the directory.

string? name

Body param: Updated name for the directory.

minLength1

ReturnsExpand Collapse

class DirectoryUpdateResponse:

API response schema for a directory.

required string ID

Unique identifier for the directory.

required string Name

Human-readable name for the directory.

minLength1

required string ProjectID

Project the directory belongs to.

DateTimeOffset? CreatedAt

Creation datetime

formatdate-time

DateTimeOffset? DeletedAt

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

formatdate-time

string? Description

Optional description shown to users.

DateTimeOffset? ExpiresAt

When this directory expires and is eligible for cleanup.

formatdate-time

IReadOnlyDictionary<string, JsonElement>? SystemMetadata

Reserved system-managed metadata.

Type? Type

Directory type: ‘user’, ‘index’, or ‘ephemeral’.

One of the following:

"ephemeral"Ephemeral

"index"Index

"user"User

DateTimeOffset? UpdatedAt

Update datetime

formatdate-time

Update Directory

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

DirectoryUpdateParams parameters = new() { DirectoryID = "directory_id" };

var directory = await client.Beta.Directories.Update(parameters);

Console.WriteLine(directory);

200 example

{
  "id": "id",
  "name": "x",
  "project_id": "project_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "system_metadata": {
    "foo": "bar"
  },
  "type": "ephemeral",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "name": "x",
  "project_id": "project_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "system_metadata": {
    "foo": "bar"
  },
  "type": "ephemeral",
  "updated_at": "2019-12-27T18:11:19.117Z"
}