✨ Publish a saved interface version | API Reference

{
  "can_edit": true,
  "code": "string",
  "compiled": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": {
    "avatar": "string",
    "id": 1,
    "username": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string"
  },
  "id": 1,
  "is_system": true,
  "projects_count": 0,
  "title": "string",
  "updated_at": "2024-01-15T09:30:00Z",
  "artifacts": null,
  "data_sample": null,
  "description": "string",
  "input_schema": null,
  "messages": null,
  "metadata": null,
  "output_schema": null,
  "scenarios": "string",
  "versions": null,
  "workspace": 1
}

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

Publish one saved interface version by stable version ID.

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.

version_idintegerRequired>=0

Stable interface version ID.

Response

can_editbooleanRead-only

Whether the current user can change this interface: edit, delete, publish versions or move it.

codestring

JSX source code for the interface screen module

compiledstring

created_atdatetimeRead-only

created_byobject

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

idintegerRead-only

is_systembooleanRead-only

HumanSignal-provided system template visible to all organizations

projects_countintegerRead-onlyDefaults to 0

titlestring<=500 characters

updated_atdatetimeRead-only

artifactsanyOptional

AI-produced code snapshots for session continuity

data_sampleanyOptional

Sample task data for preview

descriptionstringOptional

input_schemaanyOptional

JSON Schema declaring expected task data field types for import validation

messagesanyOptional

Chat conversation history

metadataany or nullOptional

Arbitrary metadata for this interface

output_schemaanyOptional

JSON Schema declaring the annotation output fields this interface produces (for Prompter/auto-labeling)

scenariosstring or nullOptional

versionsanyOptional

Code version history

workspaceinteger or nullOptional