✨ Get state backfill status | API Reference

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

{
  "completed_at": "2024-04-20T16:45:00Z",
  "created_at": "2024-04-20T14:00:00Z",
  "error_message": "Timeout error while processing project 42",
  "job_id": 12345,
  "org_status": {
    "completed_projects": 15,
    "failed_projects": 2,
    "pending_projects": 3,
    "running_projects": 5,
    "total_entities_processed": 12500,
    "total_projects": 25
  },
  "progress": {
    "failed_projects": 2,
    "successful_projects": 15,
    "total_entities_processed": 12000,
    "total_projects": 22
  },
  "rq_job_id": "rq:job:987654321",
  "rq_job_info": {
    "worker": "worker-1",
    "queue": "default",
    "enqueued_at": "2024-04-20T14:00:05Z"
  },
  "started_at": "2024-04-20T14:05:00Z",
  "status": "running",
  "triggered_by": {
    "email": "admin@example.com",
    "id": 101,
    "first_name": "Alice",
    "last_name": "Johnson"
  }
}

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: <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

Job ID (if fetching a specific job)

org_statusobject

Aggregated organization status

progressobject

rq_job_idstring or null

rq_job_infomap from strings to any or null

started_atdatetime or null

statusstring

triggered_byobject

Errors

403

Forbidden Error

404

Not Found Error