✨ List prompts | API Reference

curl http://localhost:8000/api/prompts/ \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

[
  {
    "created_at": "2024-04-10T14:22:00Z",
    "id": 101,
    "title": "Sentiment Analysis Prompt",
    "updated_at": "2024-04-15T08:45:00Z",
    "associated_projects": [
      {
        "id": 12,
        "title": "Customer Feedback Analysis"
      }
    ],
    "created_by": {
      "avatar": "https://labelstud.io/media/avatars/jdoe.png",
      "id": 42,
      "username": "jdoe",
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe"
    },
    "description": "Prompt for classifying customer sentiment in product reviews.",
    "organization": 7,
    "skill_name": "TextClassification"
  }
]

List all prompts.

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:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

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>

Query parameters

orderingstringOptional

Which field to use when ordering the results.

Response

created_atdatetimeRead-only

idintegerRead-only

titlestring<=500 characters

Model name

updated_atdatetimeRead-only

associated_projectslist of objects

created_byobject

User who created Dataset

descriptionstring or null

Model description

input_fieldsany

organizationinteger or null

output_classesany

skill_nameenum

TextClassification - TextClassification
NamedEntityRecognition - NamedEntityRecognition

* `TextClassification` - TextClassification * `NamedEntityRecognition` - NamedEntityRecognition

Allowed values: