✨ Get Agreement V2 backfill status | API Reference

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

Retrieve the status of an Agreement V2 backfill job for the authenticated user’s active organization. By default returns the aggregated organization status. Specify job_id or project_id to get a specific job status. Requires administrator or owner role and the Agreement V2 feature flag.

<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> Retrieve the status of an Agreement V2 backfill job for the authenticated user's active organization. By default returns the aggregated organization status. Specify job_id or project_id to get a specific job status. Requires administrator or owner role and the Agreement V2 feature flag.

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

job_idintegerOptional

Optional job ID to retrieve specific job status

project_idintegerOptional

Optional project ID to retrieve the latest backfill status for that project. If omitted, returns aggregated organization status.

Response

created_atdatetimeRead-only

job_idintegerRead-only

Database ID of the backfill job

project_idinteger or nullRead-only

Optional specific project to backfill (if null, backfills entire organization)

rq_job_idstring or nullRead-only

Redis queue job ID

triggered_bystringRead-only

User who triggered the backfill

completed_atdatetime or null

error_messagestring

Error message if job failed

progress_dataany

JSON data tracking job progress (matrices_created, errors, etc.)

started_atdatetime or null

statusenum

Current status of the backfill job

PENDING - Pending
QUEUED - Queued
RUNNING - Running
COMPLETED - Completed
FAILED - Failed

Allowed values:

Errors

403

Forbidden Error

404

Not Found Error

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"job_id": 42,
4	"project_id": 101,
5	"rq_job_id": "rq:job:1234567890abcdef",
6	"triggered_by": "admin_user",
7	"completed_at": "2024-01-15T12:45:00Z",
8	"error_message": "",
9	"progress_data": {
10	"matrices_created": 1500,
11	"errors": 3,
12	"rows_processed": 5000,
13	"percentage_complete": 75
14	},
15	"started_at": "2024-01-15T09:45:00Z",
16	"status": "RUNNING"
17	}

1	curl http://localhost:8000/api/dimensions/backfill/status/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json"