Prompts

✨ Get prompt

<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 specific prompt.
get/api/prompts/{id}/

Path parameters

idinteger required

A unique integer value identifying this model interface.

Response

best_scorenumber double nullable required
created_atstring date-time required
descriptionstring nullable

Model description

idinteger required
{"stackTrail":"components:schemas:ModelInterfaceSerializerGET:properties:input_fields","oasType":"schema","type":"unknown"}
organizationinteger nullable
{"stackTrail":"components:schemas:ModelInterfaceSerializerGET:properties:output_classes","oasType":"schema","type":"unknown"}
runs_countinteger required
skill_name'TextClassification' | 'NamedEntityRecognition'
  • TextClassification - TextClassification
  • NamedEntityRecognition - NamedEntityRecognition
titlestring required

Model name

updated_atstring date-time required
versions_countinteger required

Changes

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

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

      response-property-became-nullable

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

      request-parameter-type-changed

    • added the required property best_score to the response with the 200 status

      response-required-property-added

    • added the required property runs_count to the response with the 200 status

      response-required-property-added

    • added the required property versions_count to the response with the 200 status

      response-required-property-added

Of the 97 revisions, 1 has no diff computed.