Workspaces

✨ Update workspace

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Update settings for a specific workspace by ID.
patch/api/workspaces/{id}/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/workspaces/{id}/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Request body

colorstring nullable

Color

descriptionstring nullable

Workspace description

is_archivedboolean

Workspace is archived

is_personalboolean

Workspace is a personal user workspace

titlestring

Workspace Name

Response

colorstring nullable

Color

created_byinteger required
created_by_userobject nullable required

Return created_by user details when include_all_workspaces is enabled.

descriptionstring nullable

Workspace description

idinteger required
interfaces_countinteger nullable required

Saved interfaces in the workspace. A workspace with interfaces cannot be deleted.

is_archivedboolean

Workspace is archived

is_personalboolean

Workspace is a personal user workspace

membershipobject nullable required
projects_countinteger nullable required
titlestring required

Workspace Name

Changes

  • 04dae10dc373Revision changes
    • info

      added the required property to the response with the status

  • b5f055b9d45bRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

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

    • breaking

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