workspaces

Patch Workspace

Changed on

Rename a workspace in the current organization.

Requires the workspace settings manage permission. A name that is already taken returns 409.

patch/api/v1/workspaces/{workspace_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/workspaces/{workspace_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

workspace_idstring uuid required

Request body

display_namestring required

New workspace name. Letters, digits, spaces and - _ ' @ ( ) only.

Response

Successful Response

idstring uuid required
organization_idstring uuid nullable
created_atstring date-time required
display_namestring required
is_personalboolean required
is_deletedboolean required
tenant_handlestring nullable
data_plane_urlstring nullable

Changes

  • 73dfb1001b4bRevision changes
    • info

      added the non-success response with the status

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status