ML

Request interactive annotations

POST

Enable interactive pre-annotations for a specific task.

ML-assisted labeling with interactive pre-annotations works with image segmentation and object detection tasks using rectangles, ellipses, polygons, brush masks, and keypoints, as well as with HTML and text named entity recognition tasks. Your ML backend must support the type of labeling that you’re performing, recognize the input that you create, and be able to respond with the relevant output for a prediction. For more information, see Interactive pre-annotations.

Before you can use interactive annotations, it must be enabled for you ML backend connection ("is_interactive": true).

You will need the task ID and the ML backend connection ID. The task ID is available from the Label Studio URL when viewing the task, or you can retrieve it programmatically with Get task list. The ML backend connection ID is available via List ML backends.

Path parameters

idintegerRequired
A unique integer value identifying this ML backend.

Request

This endpoint expects an object.
task
integerRequired
ID of task to annotate
context
map from strings to anyOptional
Context for ML model
POST
1curl -X POST http://localhost:8080/api/ml/1/interactive-annotating \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "task": 1
6}'