✨ Move a saved interface to another workspace

POST

http://localhost:8000/api/interfaces/:id/move/

POST

/api/interfaces/:id/move/

curl -X POST http://localhost:8000/api/interfaces/1/move/ \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json" \
     -d '{
  "workspace": 1
}'

200Successful

{
  "allowed": true,
  "blockers": [
    "published_projects"
  ],
  "cannot_move_projects_count": 1,
  "connected_projects_count": 1,
  "inaccessible_projects_count": 1,
  "moving_projects_count": 1,
  "notices": [
    "target_shared"
  ],
  "published_projects_count": 1,
  "target": {
    "color": "string",
    "id": 1,
    "is_personal": true,
    "title": "string"
  },
  "workspaces": [
    {
      "outcome": "move",
      "outside_interface_workspace": true,
      "projects": [
        {
          "blocking_reasons": [
            "cannot_move"
          ],
          "id": 1,
          "is_published": true,
          "title": "string"
        }
      ],
      "published_projects_count": 1,
      "workspace": {
        "color": "string",
        "id": 1,
        "is_personal": true,
        "title": "string"
      }
    }
  ],
  "code": "interface_move_blocked",
  "detail": "string"
}

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Move a saved interface to a workspace, your Personal Sandbox, or Shared (workspace: null). A workspace-scoped interface can only be used by projects in its workspace, so connected projects move with it when needed. Send dry_run: true first to get the move plan, then confirm with dry_run: false and the expected_project_ids from that plan. The response is the plan in every case; a blocked move or a changed plan returns 409 with the fresh plan.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

Path parameters

idintegerRequired

A unique integer value identifying this interface.

Request

This endpoint expects an object.

workspaceinteger or nullRequired

Target workspace ID, or null to make the interface Shared.

dry_runbooleanOptionalDefaults to false

Return the move plan without changing anything.

expected_project_idslist of integersOptional

Required when dry_run is false: IDs of the projects in workspace groups with outcome “move” from the dry run you confirmed. If the server computes a different set, it responds with 409 “interface_move_plan_changed” and the fresh plan.

Response

allowedboolean

blockerslist of enums

Allowed values:

cannot_move_projects_countinteger

connected_projects_countinteger

All connected projects, inaccessible ones included.

inaccessible_projects_countinteger

moving_projects_countinteger

noticeslist of enums

Allowed values:

published_projects_countinteger

targetobject or null

Target workspace, or null for Shared.

workspaceslist of objects

Accessible connected projects grouped by workspace.

codeenumOptional

Present on 409 responses.

interface_move_blocked - Interface move blocked
interface_move_plan_changed - Interface move plan changed
interface_move_requires_confirmation - Interface move requires confirmation

Allowed values:

detailstringOptional

Present on 409 responses.