Skip to main content
PATCH
Change a chat workspace's details or its standing context

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

workspace_id
string<uuid>
required

Body

application/json

Rename a workspace or change its description. Omitted fields stay.

Send an empty description to clear it.

name
string | null

New name.

Required string length: 1 - 100
description
string | null

New description; empty clears it.

Maximum string length: 500
instructions
string | null

Standing instructions for the assistant, as Markdown. Added to the base prompt, never replacing it, and added to rather than replacing any the workspace sets. Cannot change which tools exist or which need approval. Empty clears them.

Maximum string length: 4000
defaults
ChatContextDefaults · object | null

Replaces the pinned defaults; send an empty object to clear them.

Response

Successful Response

A workspace, with your role in it.

id
string
required

Workspace ID.

name
string
required

Display name.

created_by
string
required

Who created it.

created_at
string<date-time>
required

When it was created.

updated_at
string<date-time>
required

When its details last changed.

your_role
enum<string>
required

Your highest role in it, directly or through a realm role.

Available options:
owner,
editor,
viewer
description
string | null

What it's for.

instructions
string | null

Standing instructions for the assistant, as Markdown. Added to the base prompt, never replacing it, and added to rather than replacing any the workspace sets. Cannot change which tools exist or which need approval.

defaults
ChatContextDefaults · object

What the assistant reaches for first in this workspace.