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

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

Authorizationstring

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>

Path parameters

project_pkintegerRequired

Query parameters

include_totalbooleanOptional

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

model_runintegerOptional

A unique ID of a ModelRun

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.

parent_modelintegerOptional

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

project_subsetstringOptional

The project subset to retrieve tasks for

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	base_url="http://localhost:8000",
5	api_key="YOUR_API_KEY_HERE"
6	)
7
8	client.prompts.subset_tasks(
9	project_pk=1
10	)

1	{
2	"count": 45,
3	"results": [
4	{
5	"task_result_list": [
6	{
7	"data": {
8	"image_url": "https://example.com/images/cat_001.jpg",
9	"metadata": {
10	"source": "user_upload",
11	"timestamp": "2024-06-10T12:00:00Z"
12	}
13	},
14	"error": {},
15	"ground_truth": {
16	"label": "cat",
17	"bbox": [
18	34,
19	45,
20	200,
21	180
22	]
23	},
24	"id": 101,
25	"prediction": {
26	"label": "cat",
27	"bbox": [
28	32,
29	47,
30	198,
31	182
32	],
33	"confidence": 0.95
34	},
35	"score": 0.92
36	}
37	],
38	"next_cursor": "cursor_789xyz",
39	"previous_cursor": "cursor_123abc",
40	"task_count": 45
41	}
42	],
43	"next": "http://localhost:8000/api/projects/1/subset-tasks?page=3",
44	"previous": "http://localhost:8000/api/projects/1/subset-tasks?page=1"
45	}

Authentication

Path parameters

Query parameters

Response

Errors