Dimensions

✨ Trigger Agreement V2 backfill

<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> Trigger an Agreement V2 backfill for the authenticated user's active organization. Recomputes agreement score matrices for all tasks that are missing them. Exactly one of three body fields must be provided:
  • project_id: backfill a single specific project.
  • num_projects: batched org backfill — queue the next N not-yet-started projects (in ascending project ID order), leaving any currently in-flight jobs untouched. Repeat calls until projects_remaining in the response reaches 0.
  • all_projects: full org backfill — cancel all in-flight jobs and queue every remaining non-completed project at once.

Requires administrator or owner role and Agreement V2 access.

post/api/dimensions/backfill/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/dimensions/backfill/
  • Auth
    API key in header Authorization

Request body

all_projectsboolean nullable

Set to true to trigger a full org backfill (cancels in-flight jobs and queues all remaining projects).

num_projectsinteger nullable

Queue at most this many projects per call (batched mode).

project_idinteger nullable

Backfill a single specific project.

Response

jobsobject[] required

Queued jobs: [{job_id, rq_job_id, project_id}]

jobs_queuedinteger required

Number of jobs queued in this request

messagestring required
organization_idinteger required
projects_remaininginteger required

Projects not yet started and not currently in-flight. Relevant when num_projects is used — call POST again until this reaches 0.

projects_skippedinteger required

Projects skipped because they already have a completed backfill

Changes

No operation changes recorded.