API ReferenceInterfaces

✨ Get a saved interface

<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> Retrieve a saved interface by 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: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idstringRequired

Response

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
artifactsany

AI-produced code snapshots for session continuity

data_sampleany
Sample task data for preview
descriptionstring
input_schemaany
JSON Schema declaring expected task data field types for import validation
messagesany
Chat conversation history
metadataany or null
Arbitrary metadata for this interface
output_schemaany

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

versionsany
Code version history
workspaceinteger or null