✨ Bulk replace review routing rules | API Reference

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

Atomically replace the ordered review routing rules for a project. Rules with an id update the existing project rule. Rules without an id are created. Existing project rules omitted from the request are deleted, and request order becomes rule order.

<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> Atomically replace the ordered review routing rules for a project. Rules with an `id` update the existing project rule. Rules without an `id` are created. Existing project rules omitted from the request are deleted, and request order becomes rule order.

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>

Path parameters

idintegerRequired

Request

This endpoint expects an object.

ruleslist of objectsRequired

Response

created_atdatetimeRead-only

Time this rule was created

orderintegerRead-only

Position in the rule list (rules are evaluated in ascending order)

updated_atdatetimeRead-only

Last time this rule was updated

agreement_thresholdstring or nullformat: "decimal"

Agreement threshold (0..1) compared against the rule operator. Required when operator is set.

dimensioninteger or null

Dimension whose agreement is compared. Null => compare overall task agreement. Deleting the dimension cascades to the rule (a dimension-scoped rule has no meaning without its dimension; falling back to overall agreement would silently change the cohort).

idinteger

operatorenum or null

Comparison operator applied to the agreement value. Null => catch-all rule.

lt - <
lte - <=
gt - >
gte - >=
eq - =

Allowed values:

sample_ratestringformat: "decimal"

Sample rate (0..1) of matching tasks routed for review. 1 always routes, 0 never routes.

$	curl -X POST http://localhost:8000/api/projects/1/review-routing-rules/bulk/ \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"rules": [
>	{
>	"agreement_threshold": "0.75",
>	"dimension": 1,
>	"operator": "lt",
>	"sample_rate": "0.50"
>	}
>	]
>	}'

1	[
2	{
3	"created_at": "2024-01-15T09:30:00Z",
4	"order": 1,
5	"updated_at": "2024-01-15T09:30:00Z",
6	"agreement_threshold": "0.75",
7	"dimension": 1,
8	"id": 1,
9	"operator": "lt",
10	"sample_rate": "0.50"
11	}
12	]