✨ Get task agreement matrix | API Reference

curl http://localhost:8000/api/projects/1/tasks/1/agreement-matrix \
     -H "Authorization: Token  <api_key>"

{
  "matrix": [
    [
      1,
      0.75,
      0.5
    ],
    [
      0.75,
      1,
      0.6
    ],
    [
      0.5,
      0.6,
      1
    ]
  ],
  "users": [
    {
      "avatar": null,
      "email": "annotator1@example.com",
      "first_name": "John",
      "id": 1,
      "initials": "JD",
      "last_name": "Doe",
      "username": "annotator1"
    },
    {
      "avatar": null,
      "email": "annotator2@example.com",
      "first_name": "Jane",
      "id": 2,
      "initials": "JS",
      "last_name": "Smith",
      "username": "annotator2"
    },
    {
      "id": "model:v1",
      "username": "Model v1"
    }
  ]
}

<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> Returns a pairwise agreement matrix between selected participants for a single task, averaged across all active dimensions or a single specified dimension.

curl http://localhost:8000/api/projects/1/tasks/1/agreement-matrix \
     -H "Authorization: Token  <api_key>"

{
  "matrix": [
    [
      1,
      0.75,
      0.5
    ],
    [
      0.75,
      1,
      0.6
    ],
    [
      0.5,
      0.6,
      1
    ]
  ],
  "users": [
    {
      "avatar": null,
      "email": "annotator1@example.com",
      "first_name": "John",
      "id": 1,
      "initials": "JD",
      "last_name": "Doe",
      "username": "annotator1"
    },
    {
      "avatar": null,
      "email": "annotator2@example.com",
      "first_name": "Jane",
      "id": 2,
      "initials": "JS",
      "last_name": "Smith",
      "username": "annotator2"
    },
    {
      "id": "model:v1",
      "username": "Model v1"
    }
  ]
}

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

Returns a pairwise agreement matrix between selected participants for a single task, averaged across all active dimensions or a single specified dimension.

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

Path parameters

project_pkintegerRequired

Project ID

task_pkintegerRequired

Task ID

Query parameters

dimensionintegerOptional

Dimension ID to compute agreement for. If not provided, averages across all active dimensions.

selectionobjectRequired

JSON object specifying which participants to include in the agreement matrix

Response

matrixlist of lists of doubles

Pairwise agreement scores matrix where matrix[i][j] is the agreement between users[i] and users[j]

userslist of maps from strings to any

Expanded participant details (annotators and/or model versions)

$	curl http://localhost:8000/api/projects/1/tasks/1/agreement-matrix \
>	-H "Authorization: Token <api_key>"

1	{
2	"matrix": [
3	[
4	1,
5	0.75,
6	0.5
7	],
8	[
9	0.75,
10	1,
11	0.6
12	],
13	[
14	0.5,
15	0.6,
16	1
17	]
18	],
19	"users": [
20	{
21	"avatar": null,
22	"email": "annotator1@example.com",
23	"first_name": "John",
24	"id": 1,
25	"initials": "JD",
26	"last_name": "Doe",
27	"username": "annotator1"
28	},
29	{
30	"avatar": null,
31	"email": "annotator2@example.com",
32	"first_name": "Jane",
33	"id": 2,
34	"initials": "JS",
35	"last_name": "Smith",
36	"username": "annotator2"
37	},
38	{
39	"id": "model:v1",
40	"username": "Model v1"
41	}
42	]
43	}