Create a new pause | API Reference

Create a new pause object for the specified project and user.

project_pkintegerRequired

Project ID

user_pkintegerRequired

User ID

This endpoint expects an object.

reasonstringRequired

verbose_reasonstringOptional

Successfully created a pause

reasonstring

idinteger or null

projectinteger or null

userinteger or null

paused_byinteger or map from strings to any or null

User who created the pause

verbose_reasonstring or null

deleted_byinteger or null

deleted_atdatetime or null

created_atdatetime or null

updated_atdatetime or null

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.projects.pauses.create(
7	project_pk=1,
8	user_pk=1,
9	reason="reason",
10	)

1	{
2	"reason": "reason",
3	"id": 1,
4	"project": 1,
5	"user": 1,
6	"paused_by": 1,
7	"verbose_reason": "verbose_reason",
8	"deleted_by": 1,
9	"deleted_at": "2024-01-15T09:30:00Z",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z"
12	}