Create task event

Create a new task event to track user interactions and system events during annotation. This endpoint is designed to receive events from the frontend labeling interface to enable accurate lead time calculation and detailed annotation analytics. ## Event Types **Core Annotation Events:** - `annotation_loaded` - When annotation interface is loaded - `annotation_created` - When annotation is submitted - `annotation_updated` - When annotation is modified - `annotation_reviewed` - When annotation is reviewed **User Activity Events:** - `visibility_change` - When page visibility changes (tab switch, minimize) - `idle_detected` - When user goes idle - `idle_resumed` - When user returns from idle **Interaction Events:** - `region_finished_drawing` - When annotation region is completed - `region_deleted` - When annotation regions are removed - `hotkey_pressed` - When keyboard shortcuts are used **Media Events:** - `video_playback_start/end` - Video playback control - `audio_playback_start/end` - Audio playback control - `video_scrub` - Video timeline scrubbing ## Usage Events are automatically associated with the task specified in the URL path. The current user is automatically set as the actor. Project and organization are derived from the task context. ## Example Request ```json { "event_key": "annotation_loaded", "event_time": "2024-01-15T10:30:00Z", "annotation": 123, "meta": { "annotation_count": 5, "estimated_time": 300 } } ```

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>

Path parameters

idintegerRequired
Task ID to associate the event with

Request

This endpoint expects an object.
event_keystringRequired1-255 characters

Event type identifier (e.g., “annotation_loaded”, “region_finished_drawing”)

event_timedatetimeRequired

Timestamp when the event occurred (frontend time)

annotationinteger or nullOptional
Annotation ID associated with this event
annotation_draft_idinteger or nullOptional
Draft annotation ID associated with this event
metaany or nullOptional

Additional event metadata (region data, hotkey info, etc.)

reviewinteger or nullOptional
Review ID associated with this event

Response

actorintegerRead-only
created_atdatetimeRead-only
event_keystring<=255 characters

Event type identifier (e.g., “annotation_loaded”, “region_finished_drawing”)

event_timedatetime

Timestamp when the event occurred (frontend time)

idintegerRead-only
organizationintegerRead-only
projectintegerRead-only
taskintegerRead-only
Task this event is associated with
annotationinteger or null
Annotation ID associated with this event
annotation_draft_idinteger or null
Draft annotation ID associated with this event
metaany or null

Additional event metadata (region data, hotkey info, etc.)

reviewinteger or null
Review ID associated with this event

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error