Sign in
workspaces

Update a workspace

Changed on
patch/workspaces/{id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring uuid required

The UUID of the workspace

Request body

namestring

Name of the workspace

descriptionstring nullable

What the workspace is for. Send null to clear it.

iconstring

Key of the workspace icon from the client icon catalogue

colorstring

Palette key or #rrggbb literal for the workspace colour

Example request

{
  "name": "Bürgeranfragen",
  "description": "Anfragen von Bürgerinnen und Bürgern bündeln",
  "icon": "landmark",
  "color": "#6b5bd6"
}

Response

The updated workspace

idstring required

Unique identifier of the workspace

namestring required

Name of the workspace

descriptionstring nullable required

What the workspace is for

instructionstring nullable required

Instructions that apply to every chat in the workspace

iconstring required

Key of the workspace icon from the client icon catalogue

colorstring required

Palette key or #rrggbb literal for the workspace colour

createdAtstring required

When the workspace was created

updatedAtstring required

When the workspace was last updated

chatCountnumber

Number of chats filed under the workspace (list responses only)

skillCountnumber

Number of skills owned by the workspace (list responses only)

knowledgeBaseCountnumber

Number of knowledge bases owned by the workspace (list responses only)

lastActivityAtstring

Later of the last edit and the most recent chat activity (list responses only)

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Bürgeranfragen",
  "description": "Anfragen von Bürgerinnen und Bürgern bündeln",
  "instruction": "Answer with the tone and policies of the building department.",
  "icon": "landmark",
  "color": "#6b5bd6",
  "createdAt": "2026-08-11T10:00:00.000Z",
  "updatedAt": "2026-08-11T10:30:00.000Z",
  "chatCount": 3,
  "skillCount": 2,
  "knowledgeBaseCount": 4,
  "lastActivityAt": "2026-08-11T10:30:00.000Z"
}

Changes

  • 761449ed9ef3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e2af65d3c5b1Revision changes
    • info

      added the required property to the response with the status