✨ Execute manual state transition | API Reference

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

Execute a registered manual transition for an entity.

<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> Execute a registered manual transition for an entity.

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

entity_idintegerRequired

entity_namestringRequired

Request

This endpoint expects an object.

transition_namestringRequired>=1 character

transition_datamap from strings to any or nullOptional

Response

new_statestring or nullRead-only

state_recordobject or null

Serializer for FSM state models. Uses Serializer instead of ModelSerializer because BaseState is abstract. Works with any concrete state model that inherits from BaseState.

successbooleanRead-only

1	curl -X POST http://localhost:8000/api/fsm/entities/entity_name/1/transition/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"transition_name": "approve"
6	}'

1	{
2	"new_state": "approved",
3	"state_record": {
4	"created_at": "2024-01-15T09:30:00Z",
5	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6	"previous_state": "pending_review",
7	"reason": "Manager approved the submission",
8	"state": "approved",
9	"transition_name": "approve",
10	"triggered_by": {
11	"id": 42,
12	"email": "manager@example.com"
13	}
14	},
15	"success": true
16	}