Interfaces

✨ Update a saved interface version description

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 the description for one saved interface version by stable version ID.
post/api/interfaces/{id}/update_description/

Request

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

Path parameters

idinteger required

A unique integer value identifying this interface.

Request body

descriptionstring required

Description to store on the saved interface version.

version_idinteger required

Stable interface version ID.

Response

artifactsunknown
can_editboolean required

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

codestring required

JSX source code for the interface screen module

compiledstring required
created_atstring date-time required
data_sampleunknown
descriptionstring
idinteger required
input_schemaunknown
is_systemboolean required

HumanSignal-provided system template visible to all organizations

messagesunknown
metadataunknown
output_schemaunknown
projects_countinteger required
scenariosstring nullable
titlestring required
updated_atstring date-time required
versionsunknown
workspaceinteger nullable

Changes