✨ Get state backfill status | API Reference

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

Retrieve the status of a state backfill job for the authenticated user’s active organization. By default returns the aggregated org status, or specify job_id or project_id to get explicit job statuses. Shows progress, completion time, and any errors. Requires administrator or owner role and both FSM feature flags (fflag_feat_fit_568_finite_state_management and fflag_feat_fit_710_fsm_state_fields).

<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 a state backfill job for the authenticated user's active organization. By default returns the aggregated org status, or specify job_id or project_id to get explicit job statuses. Shows progress, completion time, and any errors. Requires administrator or owner role and both FSM feature flags (fflag_feat_fit_568_finite_state_management and fflag_feat_fit_710_fsm_state_fields).

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 job status for a project. If omitted, returns aggregated org status.

Response

completed_atdatetime or null

created_atdatetime or null

error_messagestring or null

job_idinteger or null

Job ID (if fetching a specific job)

org_statusobject or null

Aggregated organization status

progressobject or null

rq_job_idstring or null

rq_job_infomap from strings to any or null

started_atdatetime or null

statusstring or null

triggered_byobject or null

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY_HERE"
5	)
6
7	client.states.get_backfill_status()

1	{
2	"completed_at": "2024-04-20T16:45:00Z",
3	"created_at": "2024-04-20T14:00:00Z",
4	"error_message": "Timeout error while processing project 42",
5	"job_id": 12345,
6	"org_status": {
7	"completed_projects": 15,
8	"failed_projects": 2,
9	"pending_projects": 3,
10	"running_projects": 5,
11	"total_entities_processed": 12500,
12	"total_projects": 25
13	},
14	"progress": {
15	"failed_projects": 2,
16	"successful_projects": 15,
17	"total_entities_processed": 12000,
18	"total_projects": 22
19	},
20	"rq_job_id": "rq:job:987654321",
21	"rq_job_info": {
22	"worker": "worker-1",
23	"queue": "default",
24	"enqueued_at": "2024-04-20T14:00:05Z"
25	},
26	"started_at": "2024-04-20T14:05:00Z",
27	"status": "running",
28	"triggered_by": {
29	"email": "admin@example.com",
30	"id": 101,
31	"first_name": "Alice",
32	"last_name": "Johnson"
33	}
34	}

Authentication

Query parameters

Response

Errors