Sign in
Interfaces

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

Path parameters

idinteger required

A unique integer value identifying this interface.

Request body

{"stackTrail":"components:schemas:PatchedLseInterfaceRequest:properties:artifacts","oasType":"schema","type":"unknown","description":"AI-produced code snapshots for session continuity"}
codestring

JSX source code for the interface screen module

compiledstring
{"stackTrail":"components:schemas:PatchedLseInterfaceRequest:properties:data_sample","oasType":"schema","type":"unknown","description":"Sample task data for preview"}
descriptionstring
{"stackTrail":"components:schemas:PatchedLseInterfaceRequest:properties:input_schema","oasType":"schema","type":"unknown","description":"JSON Schema declaring expected task data field types for import validation"}
{"stackTrail":"components:schemas:PatchedLseInterfaceRequest:properties:messages","oasType":"schema","type":"unknown","description":"Chat conversation history"}
{"stackTrail":"components:schemas:PatchedLseInterfaceRequest:properties:metadata","oasType":"schema","type":"unknown","description":"Arbitrary metadata for this interface","nullable":true}
{"stackTrail":"components:schemas:PatchedLseInterfaceRequest:properties:output_schema","oasType":"schema","type":"unknown","description":"JSON Schema declaring the annotation output fields this interface produces (for Prompter/auto-labeling)"}
titlestring
{"stackTrail":"components:schemas:PatchedLseInterfaceRequest:properties:versions","oasType":"schema","type":"unknown","description":"Code version history"}
workspaceinteger nullable

Response

{"stackTrail":"components:schemas:LseInterface:properties:artifacts","oasType":"schema","type":"unknown","description":"AI-produced code snapshots for session continuity"}
codestring required

JSX source code for the interface screen module

compiledstring required
created_atstring date-time required
{"stackTrail":"components:schemas:LseInterface:properties:data_sample","oasType":"schema","type":"unknown","description":"Sample task data for preview"}
descriptionstring
idinteger required
{"stackTrail":"components:schemas:LseInterface:properties:input_schema","oasType":"schema","type":"unknown","description":"JSON Schema declaring expected task data field types for import validation"}
is_systemboolean required

HumanSignal-provided system template visible to all organizations

{"stackTrail":"components:schemas:LseInterface:properties:messages","oasType":"schema","type":"unknown","description":"Chat conversation history"}
{"stackTrail":"components:schemas:LseInterface:properties:metadata","oasType":"schema","type":"unknown","description":"Arbitrary metadata for this interface","nullable":true}
{"stackTrail":"components:schemas:LseInterface:properties:output_schema","oasType":"schema","type":"unknown","description":"JSON Schema declaring the annotation output fields this interface produces (for Prompter/auto-labeling)"}
projects_countinteger required
titlestring required
updated_atstring date-time required
{"stackTrail":"components:schemas:LseInterface:properties:versions","oasType":"schema","type":"unknown","description":"Code version history"}
workspaceinteger nullable

Changes

Changed in 3 of the 97 revisions of this API.24

  • b5f055b9d45b1See the full diff
    • ▲

      the response property created_by/allOf[UserSimple]/avatar became nullable for the status 200

      response-property-became-nullable

  • c2893748a8d31See the full diff
    • ▲

      for the path request parameter id, the type/format was changed from string/ to integer/

      request-parameter-type-changed

  • b7b3b45888a84See the full diff
    • ○

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

      new-optional-request-property

    • ○

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

      new-optional-request-property

    • ○

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

      new-optional-request-property

    • ○

      added the optional property metadata to the response with the 200 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.