✨ Get Project Subset Task List with Predictions and Accuracy details | API Reference

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

{
  "count": 45,
  "results": [
    {
      "task_result_list": [
        {
          "data": {
            "image_url": "https://images.example.com/dataset/image_001.jpg",
            "metadata": {
              "source": "user_upload",
              "timestamp": "2024-06-10T12:00:00Z"
            }
          },
          "error": {},
          "ground_truth": {
            "labels": [
              {
                "class": "cat",
                "coordinates": {
                  "x": 120,
                  "y": 80,
                  "width": 200,
                  "height": 150
                }
              }
            ]
          },
          "id": 101,
          "prediction": {
            "labels": [
              {
                "class": "cat",
                "coordinates": {
                  "x": 118,
                  "y": 82,
                  "width": 198,
                  "height": 148
                }
              }
            ]
          },
          "score": 0.92
        }
      ],
      "next_cursor": "cursor_789xyz",
      "previous_cursor": "cursor_123abc",
      "task_count": 15
    }
  ],
  "next": "http://localhost:8000/api/projects/1/subset-tasks?page=3",
  "previous": "http://localhost:8000/api/projects/1/subset-tasks?page=1"
}

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Provides list of tasks, based on project subset. Includes predictions for tasks. For the ‘HasGT’ subset, accuracy metrics will also be provided.

<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> Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.

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: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

project_pkintegerRequired

Query parameters

alignment_classstringOptional

Only include tasks whose prediction/reference alignment includes this class.

alignment_from_namestringOptional

When alignment_class is set, limit matching to this output control tag.

alignment_outcomeenumOptional

Alignment outcome to drill into. Defaults to all TP, FP, and FN outcomes.

Allowed values:

include_totalbooleanOptional

If true (default), includes task_count in response; if false, omits it.

model_runintegerOptional

A unique ID of a ModelRun

model_versionintegerOptional

Restrict prefetched predictions to this specific prompt version. Used with parent_model when no model_run is selected so a newly created version does not inherit predictions from prior versions.

orderingstringOptional

Which field to use when ordering the results.

output_classstringOptional

Only include tasks whose prediction contains this output class.

output_from_namestringOptional

When output_class is set, limit matching to this output control tag.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

parent_modelintegerOptional

The ID of the parent model (ModelInterface) for this Inference Run

prediction_version_idsstringOptional

Comma-separated model version IDs. Only include tasks that have predictions for every listed version.

project_subsetstringOptional

The project subset to retrieve tasks for

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

Errors

400

Bad Request Error