Codestin Search App

from label_studio_sdk import LabelStudio
client = LabelStudio(
    base_url="http://localhost:8000",
    api_key=
)
client.tasks.list()

{
  "tasks": [
    {
      "agreement": "0.85",
      "agreement_selected": "0.90",
      "allow_skip": false,
      "annotation_time": 3600,
      "annotations": "[{\"id\": 101, \"result\": [{\"from_name\": \"label\", \"to_name\": \"image\", \"type\": \"rectanglelabels\", \"value\": {\"x\": 10, \"y\": 20, \"width\": 30, \"height\": 40, \"rectanglelabels\": [\"Car\"]}}]}]",
      "annotations_ids": "[101, 102]",
      "annotations_results": "[{\"id\": 101, \"result\": [{\"from_name\": \"label\", \"to_name\": \"image\", \"type\": \"rectanglelabels\", \"value\": {\"x\": 10, \"y\": 20, \"width\": 30, \"height\": 40, \"rectanglelabels\": [\"Car\"]}}]}]",
      "annotators": [
        12,
        34
      ],
      "annotators_count": 2,
      "avg_lead_time": 45.5,
      "cancelled_annotations": 0,
      "comment_authors": [
        {
          "id": 12,
          "name": "Alice Johnson"
        },
        {
          "id": 34,
          "name": "Bob Smith"
        }
      ],
      "comment_authors_count": 2,
      "comment_count": 5,
      "comments": "[{\"id\": 201, \"text\": \"Please check the bounding box accuracy.\", \"author_id\": 12}]",
      "completed_at": "2024-04-10T14:45:00Z",
      "created_at": "2024-04-01T08:00:00Z",
      "data": {
        "image_url": "https://example.com/images/car_001.jpg"
      },
      "draft_exists": true,
      "drafts": [
        {
          "created_at": "2024-04-09T10:00:00Z",
          "result": [
            {
              "from_name": "label",
              "to_name": "image",
              "type": "rectanglelabels",
              "value": {
                "x": 12,
                "y": 22,
                "width": 28,
                "height": 38,
                "rectanglelabels": [
                  "Car"
                ]
              }
            }
          ],
          "updated_at": "2024-04-09T12:00:00Z"
        }
      ],
      "file_upload": "car_001.jpg",
      "ground_truth": false,
      "id": 101,
      "inner_id": 101,
      "is_labeled": true,
      "last_comment_updated_at": "2024-04-10T13:00:00Z",
      "meta": {
        "source": "user_upload",
        "camera": "Nikon D3500"
      },
      "overlap": 2,
      "precomputed_agreement": 0.88,
      "predictions": [
        {
          "created_at": "2024-04-05T09:00:00Z",
          "model": {
            "id": 5,
            "name": "Car Detector v2"
          },
          "model_run": {
            "id": 15,
            "status": "completed"
          },
          "model_version": "v2.1.0",
          "project": 3,
          "result": [
            {
              "from_name": "label",
              "to_name": "image",
              "type": "rectanglelabels",
              "value": {
                "x": 11,
                "y": 21,
                "width": 29,
                "height": 39,
                "rectanglelabels": [
                  "Car"
                ]
              }
            }
          ],
          "score": 0.95,
          "task": 101,
          "updated_at": "2024-04-05T09:30:00Z"
        }
      ],
      "predictions_model_versions": "v2.1.0",
      "predictions_results": "[{\"id\": 301, \"result\": [{\"from_name\": \"label\", \"to_name\": \"image\", \"type\": \"rectanglelabels\", \"value\": {\"x\": 11, \"y\": 21, \"width\": 29, \"height\": 39, \"rectanglelabels\": [\"Car\"]}}]}]",
      "predictions_score": 0.95,
      "project": 3,
      "review_time": 1800,
      "reviewed": true,
      "reviewers": [
        {
          "id": 45,
          "name": "Carol Lee"
        }
      ],
      "reviewers_count": 1,
      "reviews_accepted": 1,
      "reviews_rejected": 0,
      "state": "completed",
      "storage_filename": "car_001.jpg",
      "total_annotations": 2,
      "total_predictions": 1,
      "unresolved_comment_count": 1,
      "updated_at": "2024-04-10T15:00:00Z",
      "updated_by": [
        {
          "id": 12,
          "name": "Alice Johnson"
        }
      ]
    }
  ],
  "total": 123,
  "total_annotations": 456,
  "total_predictions": 78
}

Retrieve a paginated list of tasks. The response format varies based on the user’s role in the organization:

Admin/Owner: Full task details with all annotations, reviews, and metadata
Reviewer: Task details optimized for review workflow
Annotator: Task details filtered to show only user’s own annotations and assignments

Retrieve a paginated list of tasks. The response format varies based on the user's role in the organization: - **Admin/Owner**: Full task details with all annotations, reviews, and metadata - **Reviewer**: Task details optimized for review workflow - **Annotator**: Task details filtered to show only user's own annotations and assignments

Authentication

Authorizationstring

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>

Query parameters

fieldsenumOptional

Set to “all” if you want to include annotations and predictions in the response. Defaults to task_only

Allowed values:

includestringOptional

Specify which fields to include in the response

only_annotatedbooleanOptional

Filter to show only tasks that have annotations

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

projectintegerOptional

Project ID

querystringOptional

Additional query to filter tasks. It must be JSON encoded string of dict containing one of the following parameters: {“filters”: …, “selectedItems”: …, “ordering”: …}. Check Data Manager > Create View > see data field for more details about filters, selectedItems and ordering.

filters: dict with “conjunction” string (“or” or “and”) and list of filters in “items” array. Each filter is a dictionary with keys: “filter”, “operator”, “type”, “value”. Read more about available filters Example: {“conjunction”: “or”, “items”: [{“filter”: “filter:tasks:completed_at”, “operator”: “greater”, “type”: “Datetime”, “value”: “2021-01-01T00:00:00.000Z”}]} selectedItems: dictionary with keys: “all”, “included”, “excluded”. If “all” is false, “included” must be used. If “all” is true, “excluded” must be used. Examples: {“all”: false, “included”: [1, 2, 3]} or {“all”: true, “excluded”: [4, 5]} ordering: list of fields to order by. Currently, ordering is supported by only one parameter. Example: [“completed_at”]

Additional query to filter tasks. It must be JSON encoded string of dict containing one of the following parameters: {"filters": ..., "selectedItems": ..., "ordering": ...}. Check Data Manager > Create View > see data field for more details about filters, selectedItems and ordering. filters: dict with "conjunction" string ("or" or "and") and list of filters in "items" array. Each filter is a dictionary with keys: "filter", "operator", "type", "value". Read more about available filters Example: {"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]} selectedItems: dictionary with keys: "all", "included", "excluded". If "all" is false, "included" must be used. If "all" is true, "excluded" must be used. Examples: {"all": false, "included": [1, 2, 3]} or {"all": true, "excluded": [4, 5]} ordering: list of fields to order by. Currently, ordering is supported by only one parameter. Example: ["completed_at"]

resolve_uribooleanOptional

Resolve task data URIs using Cloud Storage

reviewbooleanOptional

Get tasks for review

selectedItemsstringOptional

JSON string of selected task IDs for review workflow

viewintegerOptional

View ID

Response

taskslist of objects

totalinteger

Total number of tasks

total_annotationsinteger

Total number of annotations

total_predictionsinteger

Total number of predictions

List tasks

Authentication

Query parameters

Response

Errors