Label Studio

opencollection: 1.0.0
info:
  name: API Reference
  version: 1.0.0
items:
- info:
    name: subpackage_activityLogs
    type: folder
  items:
  - info:
      name: ✨ Get activity logs
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/activity-logs/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: end_date
        value: ''
        type: query
        description: End date/time (ISO-8601) for log filtering.
      - name: method
        value: ''
        type: query
        description: HTTP request method used in the log.
      - name: ordering
        value: ''
        type: query
        description: Which field to use when ordering the results.
      - name: page
        value: ''
        type: query
        description: '[or "start"] Current page index.'
      - name: page_size
        value: ''
        type: query
        description: '[or "length"] Logs per page, use -1 to obtain all logs (might be slow).'
      - name: project
        value: ''
        type: query
        description: Project ID to filter logs.
      - name: search
        value: ''
        type: query
        description: Search expression using "AND"/"OR" to filter by request URL.
      - name: start_date
        value: ''
        type: query
        description: Start date/time (ISO-8601) for log filtering.
      - name: user
        value: ''
        type: query
        description: User ID to filter logs.
      - name: workspace
        value: ''
        type: query
        description: Workspace owner ID to filter logs.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nRetrieve activity logs filtered by works"
- info:
    name: subpackage_annotationHistory
    type: folder
  items:
  - info:
      name: ✨ List all annotation history items for annotation
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/annotation-history/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: annotation
        value: ''
        type: query
        description: Annotation ID to get annotation history items for.
      - name: ordering
        value: ''
        type: query
        description: Which field to use when ordering the results.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nList annotation history items for an ann"
  - info:
      name: ✨ Delete annotation history items
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/api/annotation-history/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: annotation
        value: ''
        type: query
        description: Annotation ID to delete annotation history items for.
      - name: project
        value: ''
        type: query
        description: Project ID to delete annotation history items for.
      - name: task
        value: ''
        type: query
        description: Task ID to delete annotation history items for.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nDelete all annotation history items for "
  - info:
      name: ✨ Retrieve a single annotation history item (full result for hydration)
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/annotation-history/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nGet one annotation history item by ID wi"
  - info:
      name: ✨ List annotation history items for project
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/projects/:id/annotation-history/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: page
        value: ''
        type: query
        description: A page number within the paginated result set.
      - name: page_size
        value: ''
        type: query
        description: Number of results to return per page.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nList all annotation history items for th"
- info:
    name: subpackage_annotationReviews
    type: folder
  items:
  - info:
      name: ✨ List reviews
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/annotation-reviews/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: annotation
        value: ''
        type: query
      - name: annotation__task__project
        value: ''
        type: query
      - name: ordering
        value: ''
        type: query
        description: Which field to use when ordering the results.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nList all reviews for a specific annotati"
  - info:
      name: ✨ Create review
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/annotation-reviews/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: async_postprocess
        value: ''
        type: query
        description: Whether to postprocess the review asynchronously.
      body:
        type: json
        data: '{}'
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nCreate a review for a specific annotatio"
  - info:
      name: ✨ Get review
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/annotation-reviews/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: A unique integer value identifying this annotation review.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nRetrieve a specific review by ID for an "
  - info:
      name: ✨ Update review
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/api/annotation-reviews/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: A unique integer value identifying this annotation review.
      body:
        type: json
        data: '{}'
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nUpdate a specific review by ID. Only all"
  - info:
      name: ✨ Delete review
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/api/annotation-reviews/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: A unique integer value identifying this annotation review.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nDelete a review by ID. Only allowed for "
- info:
    name: subpackage_annotations
    type: folder
  items:
  - info:
      name: Bulk delete annotations by IDs
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/annotations/bulk-delete/
      headers:
      - name: Authorization
        value: ''
      body:
        type: json
        data: '{}'
    docs: Delete multiple annotations by their IDs. The deletion is processed synchronously. Returns the count of deleted
      annotations in the response.
  - info:
      name: Bulk create annotations
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/annotations/bulk/
      headers:
      - name: Authorization
        value: ''
      body:
        type: json
        data: '{}'
    docs: Create multiple annotations at once
  - info:
      name: Get annotation by its ID
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/annotations/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: Retrieve a specific annotation for a task using the annotation result ID.
  - info:
      name: Update annotation
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/api/annotations/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update existing attributes on an annotation.
  - info:
      name: Delete annotation
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/api/annotations/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: Delete an annotation. This action can't be undone!
  - info:
      name: Get all task annotations
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/tasks/:id/annotations/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Task ID
      - name: ordering
        value: ''
        type: query
        description: Which field to use when ordering the results.
    docs: List all annotations for a task.
  - info:
      name: Create annotation
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/tasks/:id/annotations/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Task ID
      body:
        type: json
        data: '{}'
    docs: "\n        Add annotations to a task like an annotator does. The content of the result field depends on your\n \
      \       labeling configuration. For example, send the following data as part of your POST\n        request to send an\
      \ empty annotation with the ID of the user who completed the task:\n\n        ```json\n        {\n        \"result\"\
      : {},\n        \"was_cancelled\": true,\n        \"ground_truth\": true,\n        \"lead_time\": 0,\n        \"task\"\
      : 0\n        \"completed_by\": 123\n        }\n        ```\n        "
- info:
    name: subpackage_billing
    type: folder
  items:
  - info:
      name: ✨ Get billing info
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/billing/info
      headers:
      - name: Authorization
        value: ''
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nRetrieve billing checks and feature flag"
- info:
    name: subpackage_comments
    type: folder
  items:
  - info:
      name: ✨ List comments
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/comments/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: annotation
        value: ''
        type: query
      - name: annotators
        value: ''
        type: query
      - name: draft
        value: ''
        type: query
      - name: expand_created_by
        value: ''
        type: query
      - name: ordering
        value: ''
        type: query
        description: Which field to use when ordering the results.
      - name: projects
        value: ''
        type: query
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nList all comments for a specific annotat"
  - info:
      name: ✨ Create comment
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/comments/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: expand_created_by
        value: ''
        type: query
        description: Expand the created_by field
      body:
        type: json
        data: '{}'
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nCreate a comment for a specific annotati"
  - info:
      name: ✨ Export comments to CSV
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/comments/export/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: annotation
        value: ''
        type: query
      - name: annotators
        value: ''
        type: query
      - name: draft
        value: ''
        type: query
      - name: expand_created_by
        value: ''
        type: query
      - name: projects
        value: ''
        type: query
      - name: tz
        value: ''
        type: query
        description: Timezone in which to export the data. Format IANA timezone name, e.g. "America/New_York"
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nExport comments to CSV file"
  - info:
      name: ✨ Get comment
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/comments/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: expand_created_by
        value: ''
        type: query
        description: Expand the created_by field
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nRetrieve a specific comment by ID for an"
  - info:
      name: ✨ Update comment
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/api/comments/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: expand_created_by
        value: ''
        type: query
        description: Expand the created_by field
      body:
        type: json
        data: '{}'
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nUpdate a specific comment by ID."
  - info:
      name: ✨ Delete comment
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/api/comments/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: expand_created_by
        value: ''
        type: query
        description: Expand the created_by field
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nDelete a comment by ID"
- info:
    name: subpackage_users
    type: folder
  items:
  - info:
      name: ✨ Get current user info
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/current-user
      headers:
      - name: Authorization
        value: ''
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nGet info about the currently authenticat"
  - info:
      name: ✨ Update current user
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/api/current-user
      headers:
      - name: Authorization
        value: ''
      body:
        type: json
        data: '{}'
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nUpdate details for the currently authent"
  - info:
      name: Get user hotkeys
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/current-user/hotkeys/
      headers:
      - name: Authorization
        value: ''
    docs: Retrieve the custom hotkeys configuration for the current user.
  - info:
      name: Update user hotkeys
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/api/current-user/hotkeys/
      headers:
      - name: Authorization
        value: ''
      body:
        type: json
        data: '{}'
    docs: Update the custom hotkeys configuration for the current user.
  - info:
      name: Reset user token
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/current-user/reset-token/
      headers:
      - name: Authorization
        value: ''
    docs: Reset the user token for the current user.
  - info:
      name: Get user token
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/current-user/token
      headers:
      - name: Authorization
        value: ''
    docs: Get a user token to authenticate to the API as the current user.
  - info:
      name: Retrieve my user
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/current-user/whoami
      headers:
      - name: Authorization
        value: ''
    docs: Retrieve details of the account that you are using to access the API.
  - info:
      name: List users
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/users/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: ordering
        value: ''
        type: query
        description: Which field to use when ordering the results.
    docs: List the users that exist on the Label Studio server.
  - info:
      name: Create new user
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/users/
      headers:
      - name: Authorization
        value: ''
      body:
        type: json
        data: '{}'
    docs: Create a user in Label Studio.
  - info:
      name: Get user info
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/users/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: User ID
    docs: Get info about a specific Label Studio user, based on the user ID.
  - info:
      name: Update user details
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/api/users/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: User ID
      body:
        type: json
        data: '{}'
    docs: "\n        Update details for a specific user, such as their name or contact information, in Label Studio.\n   \
      \     "
  - info:
      name: Delete user
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/api/users/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: User ID
    docs: 'Delete a specific Label Studio user. Only available in community edition.


      <Warning>Use caution when deleting a user, as this can cause issues such as breaking the "Annotated by" filter or leaving
      orphaned records.</Warning>'
- info:
    name: subpackage_dimensions
    type: folder
  items:
  - info:
      name: ✨ Trigger Agreement V2 backfill
      type: http
    http:
      method: POST
      url: http://localhost:8000/api/dimensions/backfill/
      headers:
      - name: Authorization
        value: ''
      body:
        type: json
        data: '{}'
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nTrigger an Agreement V2 backfill for the"
  - info:
      name: ✨ Cancel Agreement V2 backfill jobs
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/api/dimensions/backfill/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: job_id
        value: ''
        type: query
        description: Optional specific job ID to cancel
      - name: project_id
        value: ''
        type: query
        description: Optional project ID to cancel its active backfill jobs
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nCancel Agreement V2 backfill jobs for th"
  - info:
      name: ✨ List Agreement V2 backfill jobs
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/dimensions/backfill/jobs/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: status
        value: ''
        type: query
        description: 'Filter by job status: PENDING, QUEUED, RUNNING, COMPLETED, or FAILED.'
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nRetrieve Agreement V2 backfill jobs for "
  - info:
      name: ✨ Get Agreement V2 backfill status
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/dimensions/backfill/status/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: job_id
        value: ''
        type: query
        description: Optional job ID to retrieve specific job status
      - name: project_id
        value: ''
        type: query
        description: Optional project ID to retrieve the latest backfill status for that project. If omitted, returns aggregated
          organization status.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nRetrieve the status of an Agreement V2 b"
  - info:
      name: ✨ List dimensions
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/projects/:project_pk/dimensions/
      headers:
      - name: Authorization
        value: ''
      params:
      - name: project_pk
        value: ''
        type: path
        description: Project ID
      - name: agreement_methodology
        value: ''
        type: query
        description: 'Agreement methodology to use for computing allowed_metrics_with_params. If not provided, uses the methodology
          stored in the project settings. Valid values: "pairwise", "consensus". '
      - name: is_active
        value: ''
        type: query
        description: Filter by active status
      - name: ordering
        value: ''
        type: query
        description: Which field to use when ordering the results.
    docs: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px;\
      \ margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n\
      \        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio\
      \ Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n\
      \    </Card>\nList all dimensions for a specific proje"
  - info:
      name: ✨ Get dimension
      type: http
    http:
      method: GET
      url: http://localhost:8000/api/projects/:project_pk/dimensions/:id/
      headers:
      - name: Authorization
        value: ''
      params:
      - name:

# --- truncated at 32 KB (311 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/label-studio/refs/heads/main/apis.yml