✨ List prompts | API Reference

{
  "count": 123,
  "results": [
    {
      "best_score": 1.1,
      "created_at": "2024-01-15T09:30:00Z",
      "id": 1,
      "runs_count": 0,
      "title": "string",
      "updated_at": "2024-01-15T09:30:00Z",
      "versions_count": 0,
      "associated_projects": [
        {
          "id": 1,
          "title": "string"
        }
      ],
      "created_by": {
        "avatar": "string",
        "id": 1,
        "username": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string"
      },
      "description": "string",
      "organization": 1,
      "skill_name": "TextClassification"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

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]"

Query parameters

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Response

This endpoint returns an object.

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"