Interfaces

✨ Partially update a saved interface

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> Partially update a saved interface.
patch/api/interfaces/{id}/

Request

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

Path parameters

idinteger required

A unique integer value identifying this interface.

Request body

artifactsunknown
codestring

JSX source code for the interface screen module

compiledstring
data_sampleunknown
descriptionstring
input_schemaunknown
messagesunknown
metadataunknown
output_schemaunknown
scenariosstring nullable
titlestring
versionsunknown
workspaceinteger nullable

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

  • 04dae10dc373Revision changes
    • info

      added the required property to the response with the status

  • 4ad4a6d9f25fRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status