Interfaces

✨ Move a saved interface to another 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> 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.
post/api/interfaces/{id}/move/

Request

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

Path parameters

idinteger required

A unique integer value identifying this interface.

Request body

dry_runboolean

Return the move plan without changing anything.

expected_project_idsinteger[]

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.

workspaceinteger nullable required

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

Response

allowedboolean required
blockersInterfaceMoveBlockerEnum[] required
cannot_move_projects_countinteger required
code'interface_move_blocked' | 'interface_move_plan_changed' | 'interface_move_requires_confirmation'
  • interface_move_blocked - Interface move blocked
  • interface_move_plan_changed - Interface move plan changed
  • interface_move_requires_confirmation - Interface move requires confirmation
connected_projects_countinteger required

All connected projects, inaccessible ones included.

detailstring

Present on 409 responses.

inaccessible_projects_countinteger required
moving_projects_countinteger required
noticesInterfaceMoveNoticeEnum[] required
published_projects_countinteger required

Changes