naftiko: 1.0.0-alpha2
info:
  label: API Reference
  description: API Reference API capability.
  tags:
  - Label
  - Studio
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: label-studio
    baseUri: http://localhost:8000
    description: API Reference HTTP API.
    authentication:
      type: apikey
      in: header
      name: Authorization
      value: '{{LABEL_STUDIO_TOKEN}}'
    resources:
    - name: api-activity-logs
      path: /api/activity-logs/
      operations:
      - name: list
        method: GET
        description: ✨ Get activity logs
        inputParameters:
        - name: end_date
          in: query
          type: string
          description: End date/time (ISO-8601) for log filtering.
        - name: method
          in: query
          type: string
          description: HTTP request method used in the log.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: page
          in: query
          type: integer
          description: '[or "start"] Current page index.'
        - name: page_size
          in: query
          type: integer
          description: '[or "length"] Logs per page, use -1 to obtain all logs (might be slow).'
        - name: project
          in: query
          type: integer
          description: Project ID to filter logs.
        - name: search
          in: query
          type: string
          description: Search expression using "AND"/"OR" to filter by request URL.
        - name: start_date
          in: query
          type: string
          description: Start date/time (ISO-8601) for log filtering.
        - name: user
          in: query
          type: integer
          description: User ID to filter logs.
        - name: workspace
          in: query
          type: integer
          description: Workspace owner ID to filter logs.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-annotation-history
      path: /api/annotation-history/
      operations:
      - name: list
        method: GET
        description: ✨ List all annotation history items for annotation
        inputParameters:
        - name: annotation
          in: query
          type: integer
          description: Annotation ID to get annotation history items for.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete
        method: DELETE
        description: ✨ Delete annotation history items
        inputParameters:
        - name: annotation
          in: query
          type: integer
          description: Annotation ID to delete annotation history items for.
        - name: project
          in: query
          type: integer
          description: Project ID to delete annotation history items for.
        - name: task
          in: query
          type: integer
          description: Task ID to delete annotation history items for.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-annotation-history-id
      path: /api/annotation-history/{id}/
      operations:
      - name: retrieve
        method: GET
        description: ✨ Retrieve a single annotation history item (full result for hydration)
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-projects-id-annotation-history
      path: /api/projects/{id}/annotation-history/
      operations:
      - name: list-for-project
        method: GET
        description: ✨ List annotation history items for project
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: page
          in: query
          type: integer
          description: A page number within the paginated result set.
        - name: page_size
          in: query
          type: integer
          description: Number of results to return per page.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-annotation-reviews
      path: /api/annotation-reviews/
      operations:
      - name: list
        method: GET
        description: ✨ List reviews
        inputParameters:
        - name: annotation
          in: query
          type: integer
        - name: annotation__task__project
          in: query
          type: integer
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: create
        method: POST
        description: ✨ Create review
        inputParameters:
        - name: async_postprocess
          in: query
          type: boolean
          description: Whether to postprocess the review asynchronously.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-annotation-reviews-id
      path: /api/annotation-reviews/{id}/
      operations:
      - name: get
        method: GET
        description: ✨ Get review
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this annotation review.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete
        method: DELETE
        description: ✨ Delete review
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this annotation review.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update
        method: PATCH
        description: ✨ Update review
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: A unique integer value identifying this annotation review.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-annotations-bulk-delete
      path: /api/annotations/bulk-delete/
      operations:
      - name: delete-bulk
        method: POST
        description: Bulk delete annotations by IDs
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-annotations-bulk
      path: /api/annotations/bulk/
      operations:
      - name: create-bulk
        method: POST
        description: Bulk create annotations
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-annotations-id
      path: /api/annotations/{id}/
      operations:
      - name: get
        method: GET
        description: Get annotation by its ID
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete
        method: DELETE
        description: Delete annotation
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update
        method: PATCH
        description: Update annotation
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-tasks-id-annotations
      path: /api/tasks/{id}/annotations/
      operations:
      - name: list
        method: GET
        description: Get all task annotations
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: Task ID
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: create
        method: POST
        description: Create annotation
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: Task ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-billing-info
      path: /api/billing/info
      operations:
      - name: info
        method: GET
        description: ✨ Get billing info
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-comments
      path: /api/comments/
      operations:
      - name: list
        method: GET
        description: ✨ List comments
        inputParameters:
        - name: annotation
          in: query
          type: integer
        - name: annotators
          in: query
          type: string
        - name: draft
          in: query
          type: integer
        - name: expand_created_by
          in: query
          type: boolean
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: projects
          in: query
          type: string
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: create
        method: POST
        description: ✨ Create comment
        inputParameters:
        - name: expand_created_by
          in: query
          type: boolean
          description: Expand the created_by field
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-comments-export
      path: /api/comments/export/
      operations:
      - name: export
        method: GET
        description: ✨ Export comments to CSV
        inputParameters:
        - name: annotation
          in: query
          type: integer
        - name: annotators
          in: query
          type: string
        - name: draft
          in: query
          type: integer
        - name: expand_created_by
          in: query
          type: boolean
        - name: projects
          in: query
          type: string
        - name: tz
          in: query
          type: string
          description: Timezone in which to export the data. Format IANA timezone name, e.g. "America/New_York"
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-comments-id
      path: /api/comments/{id}/
      operations:
      - name: get
        method: GET
        description: ✨ Get comment
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: expand_created_by
          in: query
          type: boolean
          description: Expand the created_by field
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete
        method: DELETE
        description: ✨ Delete comment
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: expand_created_by
          in: query
          type: boolean
          description: Expand the created_by field
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update
        method: PATCH
        description: ✨ Update comment
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: expand_created_by
          in: query
          type: boolean
          description: Expand the created_by field
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-current-user
      path: /api/current-user
      operations:
      - name: get-current-user
        method: GET
        description: ✨ Get current user info
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update-current-user
        method: PATCH
        description: ✨ Update current user
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-current-user-hotkeys
      path: /api/current-user/hotkeys/
      operations:
      - name: get-hotkeys
        method: GET
        description: Get user hotkeys
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update-hotkeys
        method: PATCH
        description: Update user hotkeys
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-current-user-reset-token
      path: /api/current-user/reset-token/
      operations:
      - name: reset-token
        method: POST
        description: Reset user token
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-current-user-token
      path: /api/current-user/token
      operations:
      - name: get-token
        method: GET
        description: Get user token
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-current-user-whoami
      path: /api/current-user/whoami
      operations:
      - name: whoami
        method: GET
        description: Retrieve my user
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-users
      path: /api/users/
      operations:
      - name: list
        method: GET
        description: List users
        inputParameters:
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: create
        method: POST
        description: Create new user
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-users-id
      path: /api/users/{id}/
      operations:
      - name: get
        method: GET
        description: Get user info
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: User ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete
        method: DELETE
        description: Delete user
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: User ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update
        method: PATCH
        description: Update user details
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: User ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dimensions-backfill
      path: /api/dimensions/backfill/
      operations:
      - name: trigger-backfill
        method: POST
        description: ✨ Trigger Agreement V2 backfill
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: cancel-backfill
        method: DELETE
        description: ✨ Cancel Agreement V2 backfill jobs
        inputParameters:
        - name: job_id
          in: query
          type: integer
          description: Optional specific job ID to cancel
        - name: project_id
          in: query
          type: integer
          description: Optional project ID to cancel its active backfill jobs
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dimensions-backfill-jobs
      path: /api/dimensions/backfill/jobs/
      operations:
      - name: list-backfills
        method: GET
        description: ✨ List Agreement V2 backfill jobs
        inputParameters:
        - name: status
          in: query
          type: string
          description: 'Filter by job status: PENDING, QUEUED, RUNNING, COMPLETED, or FAILED.'
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dimensions-backfill-status
      path: /api/dimensions/backfill/status/
      operations:
      - name: get-backfill-status
        method: GET
        description: ✨ Get Agreement V2 backfill status
        inputParameters:
        - name: job_id
          in: query
          type: integer
          description: Optional job ID to retrieve specific job status
        - name: project_id
          in: query
          type: integer
          description: Optional project ID to retrieve the latest backfill status for that project. If omitted, returns aggregated
            organization status.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-projects-project-pk-dimensions
      path: /api/projects/{project_pk}/dimensions/
      operations:
      - name: list
        method: GET
        description: ✨ List dimensions
        inputParameters:
        - name: project_pk
          in: path
          type: integer
          required: true
          description: Project ID
        - name: agreement_methodology
          in: query
          type: string
          description: 'Agreement methodology to use for computing allowed_metrics_with_params. If not provided, uses the
            methodology stored in the project settings. Valid values: "pai'
        - name: is_active
          in: query
          type: boolean
          description: Filter by active status
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-projects-project-pk-dimensions-id
      path: /api/projects/{project_pk}/dimensions/{id}/
      operations:
      - name: get
        method: GET
        description: ✨ Get dimension
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
          description: Dimension ID
        - name: project_pk
          in: path
          type: integer
          required: true
          description: Project ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dm-actions
      path: /api/dm/actions/
      operations:
      - name: list
        method: GET
        description: Get actions
        inputParameters:
        - name: project
          in: query
          type: integer
          required: true
          description: Project ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: create
        method: POST
        description: Post actions
        inputParameters:
        - name: id
          in: query
          type: string
          required: true
          description: Action name ID, see the full list of actions in the `GET api/actions` request
        - name: project
          in: query
          type: integer
          required: true
          description: Project ID
        - name: view
          in: query
          type: integer
          description: View ID (optional, it has higher priority than filters, selectedItems and ordering from the request
            body payload)
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dm-views
      path: /api/dm/views/
      operations:
      - name: list
        method: GET
        description: List views
        inputParameters:
        - name: project
          in: query
          type: integer
          description: Project ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: create
        method: POST
        description: Create view
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dm-views-order
      path: /api/dm/views/order/
      operations:
      - name: update-order
        method: POST
        description: Update order of views
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dm-views-reset
      path: /api/dm/views/reset/
      operations:
      - name: delete-all
        method: DELETE
        description: Delete all project views
        inputParameters:
        - name: project
          in: query
          type: integer
          required: true
          description: Project ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-dm-views-id
      path: /api/dm/views/{id}/
      operations:
      - name: get
        method: GET
        description: Get view details
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: View ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete
        method: DELETE
        description: Delete view
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: View ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update
        method: PATCH
        description: Update view
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: View ID
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-fsm-backfill
      path: /api/fsm/backfill/
      operations:
      - name: trigger-backfill
        method: POST
        description: ✨ Trigger state backfill for organization
        inputParameters:
        - name: project_id
          in: query
          type: integer
          description: Optional project ID to trigger backfill for a single project
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: cancel-backfill
        method: DELETE
        description: ✨ Cancel state backfill jobs
        inputParameters:
        - name: job_id
          in: query
          type: integer
          description: Optional specific job ID to cancel
        - name: project_id
          in: query
          type: integer
          description: Optional project ID to cancel its active jobs
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-fsm-backfill-jobs
      path: /api/fsm/backfill/jobs/
      operations:
      - name: list-backfills
        method: GET
        description: ✨ List state backfill jobs
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-fsm-backfill-status
      path: /api/fsm/backfill/status/
      operations:
      - name: get-backfill-status
        method: GET
        description: ✨ Get state backfill status
        inputParameters:
        - name: job_id
          in: query
          type: integer
          description: Optional job ID to retrieve specific job status
        - name: project_id
          in: query
          type: integer
          description: Optional project ID to retrieve the latest job status for a project. If omitted, returns aggregated
            org status.
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-fsm-entities-entity-name-entity-id-history
      path: /api/fsm/entities/{entity_name}/{entity_id}/history
      operations:
      - name: state-history
        method: GET
        description: ✨ Get entity state history
        inputParameters:
        - name: entity_id
          in: path
          type: integer
          required: true
        - name: entity_name
          in: path
          type: string
          required: true
        - name: created_at_from
          in: query
          type: string
          description: Filter for state history items created at or after the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)
        - name: created_at_to
          in: query
          type: string
          description: Filter for state history items created at or before the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: page
          in: query
          type: integer
          description: A page number within the paginated result set.
        - name: page_size
          in: query
          type: integer
          description: Number of results to return per page.
        - name: previous_state
          in: query
          type: string
          description: Filter previous_state by exact match (case-insensitive)
        - name: state
          in: query
          type: string
          description: Filter state by exact match (case-insensitive)
        - name: transition_name
          in: query
          type: string
          description: Filter transition_name by exact match (case-insensitive)
        - name: triggered_by
          in: query
          type: number
          description: Filter triggered_by by exact match
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-fsm-entities-entity-name-entity-id-transitio
      path: /api/fsm/entities/{entity_name}/{entity_id}/transition/
      operations:
      - name: execute-transition
        method: POST
        description: ✨ Execute manual state transition
        inputParameters:
        - name: entity_id
          in: path
          type: integer
          required: true
        - name: entity_name
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-import-file-upload-id
      path: /api/import/file-upload/{id}
      operations:
      - name: get
        method: GET
        description: Get file upload
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete
        method: DELETE
        description: Delete file upload
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: update
        method: PATCH
        description: Update file upload
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          required: true
          description: '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='
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: label-studio-rest
    description: REST adapter for API Reference.
    resources:
    - path: /api/activity-logs/
      name: list
      operations:
      - method: GET
        name: list
        description: ✨ Get activity logs
        call: label-studio.list
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-history/
      name: list
      operations:
      - method: GET
        name: list
        description: ✨ List all annotation history items for annotation
        call: label-studio.list
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-history/
      name: delete
      operations:
      - method: DELETE
        name: delete
        description: ✨ Delete annotation history items
        call: label-studio.delete
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-history/{id}/
      name: retrieve
      operations:
      - method: GET
        name: retrieve
        description: ✨ Retrieve a single annotation history item (full result for hydration)
        call: label-studio.retrieve
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/projects/{id}/annotation-history/
      name: list-for-project
      operations:
      - method: GET
        name: list-for-project
        description: ✨ List annotation history items for project
        call: label-studio.list-for-project
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-reviews/
      name: list
      operations:
      - method: GET
        name: list
        description: ✨ List reviews
        call: label-studio.list
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-reviews/
      name: create
      operations:
      - method: POST
        name: create
        description: ✨ Create review
        call: label-studio.create
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-reviews/{id}/
      name: get
      operations:
      - method: GET
        name: get
        description: ✨ Get review
        call: label-studio.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-reviews/{id}/
      name: delete
      operations:
      - method: DELETE
        name: delete
        description: ✨ Delete review
        call: label-studio.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotation-reviews/{id}/
      name: update
      operations:
      - method: PATCH
        name: update
        description: ✨ Update review
        call: label-studio.update
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotations/bulk-delete/
      name: delete-bulk
      operations:
      - method: POST
        name: delete-bulk
        description: Bulk delete annotations by IDs
        call: label-studio.delete-bulk
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotations/bulk/
      name: create-bulk
      operations:
      - method: POST
        name: create-bulk
        description: Bulk create annotations
        call: label-studio.create-bulk
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotations/{id}/
      name: get
      operations:
      - method: GET
        name: get
        description: Get annotation by its ID
        call: label-studio.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotations/{id}/
      name: delete
      operations:
      - method: DELETE
        name: delete
        description: Delete annotation
        call: label-studio.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/annotations/{id}/
      name: update
      operations:
      - method: PATCH
        name: update
        description: Update annotation
        call: label-studio.update
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/tasks/{id}/annotations/
      name: list
      operations:
      - method: GET
        name: list
        description: Get all task annotations
        call: label-studio.list
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/tasks/{id}/annotations/
      name: create
      operations:
      - method: POST
        name: create
        description: Create annotation
        call: label-studio.create
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/billing/info
      name: info
      operations:
      - method: GET
        name: info
        description: ✨ Get billing info
        call: label-studio.info
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/comments/
      name: list
      operations:
      - method: GET
        name: list
        description: ✨ List comments
        call: label-studio.list
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/comments/
      name: create
      operations:
      - method: POST
        name: create
        description: ✨ Create comment
        call: label-studio.create
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/comments/export/
      name: export
      operations:
      - method: GET
        name: export
        description: ✨ Export comments to CSV
        call: label-studio.export
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/comments/{id}/
      name: get
      operations:
      - method: GET
        name: get
        description: ✨ Get comment
        call: label-studio.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/comments/{id}/
      name: delete
      operations:
      - method: DELETE
        name: delete
        description: ✨ Delete comment
        call: label-studio.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/comments/{id}/
      name: update
      operations:
      - method: PATCH
        name: update
        description: ✨ Update comment
        call: label-studio.update
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/current-user
      name: get-current-user
      operations:
      - method: GET
        name: get-current-user
        description: ✨ Get current user info
        call: label-studio.get-current-user
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/current-user
      name: update-current-user
      operations:
      - method: PATCH
        name: update-current-user
        description: ✨ Update current user
        call: label-studio.update-current-user
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/current-user/hotkeys/
      name: get-hotkeys
      operations:
      - method: GET
        name: get-hotkeys
        description: Get user hotkeys
        call: label-studio.get-hotkeys
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/current-user/hotkeys/
      name: update-hotkeys
      operations:
      - method: PATCH
        name: update-hotkeys
        description: Update user hotkeys
        call: label-studio.update-hotkeys
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/current-user/reset-token/
      name: reset-token
      operations:
      - method: POST
        name: reset-token
        description: Reset user token
        call: label-studio.reset-token
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/current-user/token
      name: get-token
      operations:
      - method: GET
        name: get-token
        description: Get user token
        call: label-studio.get-token
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/current-user/whoami
      name: whoami
      operations:
      - method: GET
        name: whoami
        description: Retrieve my user
        call: label-studio.whoami
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/users/
      name: list
      operations:
      - method: GET
        name: list
        description: List users
        call: label-studio.list
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/users/
      name: create
      operations:
      - method: POST
        name: create
        description: Create new user
        call: label-studio.create
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/users/{id}/
      name: get
      operations:
      - method: GET
        name: get
        description: Get user info
        call: label-studio.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/users/{id}/
      name: delete
      operations:
      - method: DELETE
        name: delete
        description: Delete user
        call: label-studio.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/users/{id}/
      name: update
      operations:
      - method: PATCH
        name: update
        description: Update user details
        call: label-studio.update
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dimensions/backfill/
      name: trigger-backfill
      operations:
      - method: POST
        name: trigger-backfill
        description: ✨ Trigger Agreement V2 backfill
        call: label-studio.trigger-backfill
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dimensions/backfill/
      name: cancel-backfill
      operations:
      - method: DELETE
        name: cancel-backfill
        description: ✨ Cancel Agreement V2 backfill jobs
        call: label-studio.cancel-backfill
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dimensions/backfill/jobs/
      name: list-backfills
      operations:
      - method: GET
        name: list-backfills
        description: ✨ List Agreement V2 backfill jobs
        call: label-studio.list-backfills
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dimensions/backfill/status/
      name: get-backfill-status
      operations:
      - method: GET
        name: get-backfill-status
        description: ✨ Get Agreement V2 backfill status
        call: label-studio.get-backfill-status
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/projects/{project_pk}/dimensions/
      name: list
      operations:
      - method: GET
        name: list
        description: ✨ List dimensions
        call: label-studio.list
        with:
          project_pk: rest.project_pk
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/projects/{project_pk}/dimensions/{id}/
      name: get
      operations:
      - method: GET
        name: get
        description: ✨ Get dimension
        call: label-studio.get
        with:
          id: rest.id
          project_pk: rest.project_pk
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/actions/
      name: list
      operations:
      - method: GET
        name: list
        description: Get actions
        call: label-studio.list
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/actions/
      name: create
      operations:
      - method: POST
        name: create
        description: Post actions
        call: label-studio.create
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/views/
      name: list
      operations:
      - method: GET
        name: list
        description: List views
        call: label-studio.list
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/views/
      name: create
      operations:
      - method: POST
        name: create
        description: Create view
        call: label-studio.create
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/views/order/
      name: update-order
      operations:
      - method: POST
        name: update-order
        description: Update order of views
        call: label-studio.update-order
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/views/reset/
      name: delete-all
      operations:
      - method: DELETE
        name: delete-all
        description: Delete all project views
        call: label-studio.delete-all
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/views/{id}/
      name: get
      operations:
      - method: GET
        name: get
        description: Get view details
        call: label-studio.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/views/{id}/
      name: delete
      operations:
      - method: DELETE
        name: delete
        description: Delete view
        call: label-studio.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/dm/views/{id}/
      name: update
      operations:
      - method: PATCH
        name: update
        description: Update view
        call: label-studio.update
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/fsm/backfill/
      name: trigger-backfill
      operations:
      - method: POST
        name: trigger-backfill
        description: ✨ Trigger state backfill for organization
        call: label-studio.trigger-backfill
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/fsm/backfill/
      name: cancel-backfill
      operations:
      - method: DELETE
        name: cancel-backfill
        description: ✨ Cancel state backfill jobs
        call: label-studio.cancel-backfill
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/fsm/backfill/jobs/
      name: list-backfills
      operations:
      - method: GET
        name: list-backfills
        description: ✨ List state backfill jobs
        call: label-studio.list-backfills
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/fsm/backfill/status/
      name: get-backfill-status
      operations:
      - method: GET
        name: get-backfill-status
        description: ✨ Get state backfill status
        call: label-studio.get-backfill-status
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/fsm/entities/{entity_name}/{entity_id}/history
      name: state-history
      operations:
      - method: GET
        name: state-history
        description: ✨ Get entity state history
        call: label-studio.state-history
        with:
          entity_id: rest.entity_id
          entity_name: rest.entity_name
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/fsm/entities/{entity_name}/{entity_id}/transition/
      name: execute-transition
      operations:
      - method: POST
        name: execute-transition
        description: ✨ Execute manual state transition
        call: label-studio.execute-transition
        with:
          entity_id: rest.entity_id
          entity_name: rest.entity_name
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/import/file-upload/{id}
      name: get
      operations:
      - method: GET
        name: get
        description: Get file upload
        call: label-studio.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/import/file-upload/{id}
      name: delete
      operations:
      - method: DELETE
        name: delete
        description: Delete file upload
        call: label-studio.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /api/import/file-upload/{id}
      name: update
      operations:
      - method: PATCH
        name: update
        description: Update file upload
        call: label-studio.update
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: label-studio-mcp
    transport: http
    description: MCP adapter for API Reference for AI agent use.
    tools:
    - name: list
      description: ✨ Get activity logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        end_date: tools.end_date
        method: tools.method
        ordering: tools.ordering
        page: tools.page
        page_size: tools.page_size
        project: tools.project
        search: tools.search
        start_date: tools.start_date
        user: tools.user
        workspace: tools.workspace
      inputParameters:
      - name: end_date
        type: string
        description: End date/time (ISO-8601) for log filtering.
      - name: method
        type: string
        description: HTTP request method used in the log.
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      - name: page
        type: integer
        description: '[or "start"] Current page index.'
      - name: page_size
        type: integer
        description: '[or "length"] Logs per page, use -1 to obtain all logs (might be slow).'
      - name: project
        type: integer
        description: Project ID to filter logs.
      - name: search
        type: string
        description: Search expression using "AND"/"OR" to filter by request URL.
      - name: start_date
        type: string
        description: Start date/time (ISO-8601) for log filtering.
      - name: user
        type: integer
        description: User ID to filter logs.
      - name: workspace
        type: integer
        description: Workspace owner ID to filter logs.
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: ✨ List all annotation history items for annotation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        annotation: tools.annotation
        ordering: tools.ordering
      inputParameters:
      - name: annotation
        type: integer
        description: Annotation ID to get annotation history items for.
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: ✨ Delete annotation history items
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete
      with:
        annotation: tools.annotation
        project: tools.project
        task: tools.task
      inputParameters:
      - name: annotation
        type: integer
        description: Annotation ID to delete annotation history items for.
      - name: project
        type: integer
        description: Project ID to delete annotation history items for.
      - name: task
        type: integer
        description: Task ID to delete annotation history items for.
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve
      description: ✨ Retrieve a single annotation history item (full result for hydration)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.retrieve
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: list-for-project
      description: ✨ List annotation history items for project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list-for-project
      with:
        id: tools.id
        page: tools.page
        page_size: tools.page_size
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      - name: page
        type: integer
        description: A page number within the paginated result set.
      - name: page_size
        type: integer
        description: Number of results to return per page.
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: ✨ List reviews
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        annotation: tools.annotation
        annotation__task__project: tools.annotation__task__project
        ordering: tools.ordering
      inputParameters:
      - name: annotation
        type: integer
        description: annotation
      - name: annotation__task__project
        type: integer
        description: annotation__task__project
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      outputParameters:
      - type: object
        mapping: $.
    - name: create
      description: ✨ Create review
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.create
      with:
        async_postprocess: tools.async_postprocess
      inputParameters:
      - name: async_postprocess
        type: boolean
        description: Whether to postprocess the review asynchronously.
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: ✨ Get review
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: A unique integer value identifying this annotation review.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: ✨ Delete review
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: A unique integer value identifying this annotation review.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: ✨ Update review
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: A unique integer value identifying this annotation review.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-bulk
      description: Bulk delete annotations by IDs
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.delete-bulk
      outputParameters:
      - type: object
        mapping: $.
    - name: create-bulk
      description: Bulk create annotations
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.create-bulk
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: Get annotation by its ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: Delete annotation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: Update annotation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: Get all task annotations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        id: tools.id
        ordering: tools.ordering
      inputParameters:
      - name: id
        type: integer
        description: Task ID
        required: true
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      outputParameters:
      - type: object
        mapping: $.
    - name: create
      description: Create annotation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.create
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: Task ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: info
      description: ✨ Get billing info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.info
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: ✨ List comments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        annotation: tools.annotation
        annotators: tools.annotators
        draft: tools.draft
        expand_created_by: tools.expand_created_by
        ordering: tools.ordering
        projects: tools.projects
      inputParameters:
      - name: annotation
        type: integer
        description: annotation
      - name: annotators
        type: string
        description: annotators
      - name: draft
        type: integer
        description: draft
      - name: expand_created_by
        type: boolean
        description: expand_created_by
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      - name: projects
        type: string
        description: projects
      outputParameters:
      - type: object
        mapping: $.
    - name: create
      description: ✨ Create comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.create
      with:
        expand_created_by: tools.expand_created_by
      inputParameters:
      - name: expand_created_by
        type: boolean
        description: Expand the created_by field
      outputParameters:
      - type: object
        mapping: $.
    - name: export
      description: ✨ Export comments to CSV
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.export
      with:
        annotation: tools.annotation
        annotators: tools.annotators
        draft: tools.draft
        expand_created_by: tools.expand_created_by
        projects: tools.projects
        tz: tools.tz
      inputParameters:
      - name: annotation
        type: integer
        description: annotation
      - name: annotators
        type: string
        description: annotators
      - name: draft
        type: integer
        description: draft
      - name: expand_created_by
        type: boolean
        description: expand_created_by
      - name: projects
        type: string
        description: projects
      - name: tz
        type: string
        description: Timezone in which to export the data. Format IANA timezone name, e.g. "America/New_York"
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: ✨ Get comment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get
      with:
        id: tools.id
        expand_created_by: tools.expand_created_by
      inputParameters:
      - name: id
        type: string
        description: id
        required: true
      - name: expand_created_by
        type: boolean
        description: Expand the created_by field
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: ✨ Delete comment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete
      with:
        id: tools.id
        expand_created_by: tools.expand_created_by
      inputParameters:
      - name: id
        type: string
        description: id
        required: true
      - name: expand_created_by
        type: boolean
        description: Expand the created_by field
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: ✨ Update comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update
      with:
        id: tools.id
        expand_created_by: tools.expand_created_by
      inputParameters:
      - name: id
        type: string
        description: id
        required: true
      - name: expand_created_by
        type: boolean
        description: Expand the created_by field
      outputParameters:
      - type: object
        mapping: $.
    - name: get-current-user
      description: ✨ Get current user info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get-current-user
      outputParameters:
      - type: object
        mapping: $.
    - name: update-current-user
      description: ✨ Update current user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update-current-user
      outputParameters:
      - type: object
        mapping: $.
    - name: get-hotkeys
      description: Get user hotkeys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get-hotkeys
      outputParameters:
      - type: object
        mapping: $.
    - name: update-hotkeys
      description: Update user hotkeys
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update-hotkeys
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-token
      description: Reset user token
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.reset-token
      outputParameters:
      - type: object
        mapping: $.
    - name: get-token
      description: Get user token
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get-token
      outputParameters:
      - type: object
        mapping: $.
    - name: whoami
      description: Retrieve my user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.whoami
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: List users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        ordering: tools.ordering
      inputParameters:
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      outputParameters:
      - type: object
        mapping: $.
    - name: create
      description: Create new user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.create
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: Get user info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: User ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: Delete user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: User ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: Update user details
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: User ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-backfill
      description: ✨ Trigger Agreement V2 backfill
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.trigger-backfill
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-backfill
      description: ✨ Cancel Agreement V2 backfill jobs
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.cancel-backfill
      with:
        job_id: tools.job_id
        project_id: tools.project_id
      inputParameters:
      - name: job_id
        type: integer
        description: Optional specific job ID to cancel
      - name: project_id
        type: integer
        description: Optional project ID to cancel its active backfill jobs
      outputParameters:
      - type: object
        mapping: $.
    - name: list-backfills
      description: ✨ List Agreement V2 backfill jobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list-backfills
      with:
        status: tools.status
      inputParameters:
      - name: status
        type: string
        description: 'Filter by job status: PENDING, QUEUED, RUNNING, COMPLETED, or FAILED.'
      outputParameters:
      - type: object
        mapping: $.
    - name: get-backfill-status
      description: ✨ Get Agreement V2 backfill status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get-backfill-status
      with:
        job_id: tools.job_id
        project_id: tools.project_id
      inputParameters:
      - name: job_id
        type: integer
        description: Optional job ID to retrieve specific job status
      - name: project_id
        type: integer
        description: Optional project ID to retrieve the latest backfill status for that project. If omitted, returns aggregated
          organization status.
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: ✨ List dimensions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        project_pk: tools.project_pk
        agreement_methodology: tools.agreement_methodology
        is_active: tools.is_active
        ordering: tools.ordering
      inputParameters:
      - name: project_pk
        type: integer
        description: Project ID
        required: true
      - name: agreement_methodology
        type: string
        description: 'Agreement methodology to use for computing allowed_metrics_with_params. If not provided, uses the methodology
          stored in the project settings. Valid values: "pai'
      - name: is_active
        type: boolean
        description: Filter by active status
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: ✨ Get dimension
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get
      with:
        id: tools.id
        project_pk: tools.project_pk
      inputParameters:
      - name: id
        type: integer
        description: Dimension ID
        required: true
      - name: project_pk
        type: integer
        description: Project ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: Get actions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        project: tools.project
      inputParameters:
      - name: project
        type: integer
        description: Project ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: create
      description: Post actions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.create
      with:
        id: tools.id
        project: tools.project
        view: tools.view
      inputParameters:
      - name: id
        type: string
        description: Action name ID, see the full list of actions in the `GET api/actions` request
        required: true
      - name: project
        type: integer
        description: Project ID
        required: true
      - name: view
        type: integer
        description: View ID (optional, it has higher priority than filters, selectedItems and ordering from the request body
          payload)
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: List views
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list
      with:
        project: tools.project
      inputParameters:
      - name: project
        type: integer
        description: Project ID
      outputParameters:
      - type: object
        mapping: $.
    - name: create
      description: Create view
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.create
      outputParameters:
      - type: object
        mapping: $.
    - name: update-order
      description: Update order of views
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update-order
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-all
      description: Delete all project views
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete-all
      with:
        project: tools.project
      inputParameters:
      - name: project
        type: integer
        description: Project ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: Get view details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: string
        description: View ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: Delete view
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: string
        description: View ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: Update view
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: string
        description: View ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-backfill
      description: ✨ Trigger state backfill for organization
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.trigger-backfill
      with:
        project_id: tools.project_id
      inputParameters:
      - name: project_id
        type: integer
        description: Optional project ID to trigger backfill for a single project
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-backfill
      description: ✨ Cancel state backfill jobs
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.cancel-backfill
      with:
        job_id: tools.job_id
        project_id: tools.project_id
      inputParameters:
      - name: job_id
        type: integer
        description: Optional specific job ID to cancel
      - name: project_id
        type: integer
        description: Optional project ID to cancel its active jobs
      outputParameters:
      - type: object
        mapping: $.
    - name: list-backfills
      description: ✨ List state backfill jobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.list-backfills
      outputParameters:
      - type: object
        mapping: $.
    - name: get-backfill-status
      description: ✨ Get state backfill status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get-backfill-status
      with:
        job_id: tools.job_id
        project_id: tools.project_id
      inputParameters:
      - name: job_id
        type: integer
        description: Optional job ID to retrieve specific job status
      - name: project_id
        type: integer
        description: Optional project ID to retrieve the latest job status for a project. If omitted, returns aggregated org
          status.
      outputParameters:
      - type: object
        mapping: $.
    - name: state-history
      description: ✨ Get entity state history
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.state-history
      with:
        entity_id: tools.entity_id
        entity_name: tools.entity_name
        created_at_from: tools.created_at_from
        created_at_to: tools.created_at_to
        ordering: tools.ordering
        page: tools.page
        page_size: tools.page_size
        previous_state: tools.previous_state
        state: tools.state
        transition_name: tools.transition_name
        triggered_by: tools.triggered_by
      inputParameters:
      - name: entity_id
        type: integer
        description: entity_id
        required: true
      - name: entity_name
        type: string
        description: entity_name
        required: true
      - name: created_at_from
        type: string
        description: Filter for state history items created at or after the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)
      - name: created_at_to
        type: string
        description: Filter for state history items created at or before the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)
      - name: ordering
        type: string
        description: Which field to use when ordering the results.
      - name: page
        type: integer
        description: A page number within the paginated result set.
      - name: page_size
        type: integer
        description: Number of results to return per page.
      - name: previous_state
        type: string
        description: Filter previous_state by exact match (case-insensitive)
      - name: state
        type: string
        description: Filter state by exact match (case-insensitive)
      - name: transition_name
        type: string
        description: Filter transition_name by exact match (case-insensitive)
      - name: triggered_by
        type: number
        description: Filter triggered_by by exact match
      outputParameters:
      - type: object
        mapping: $.
    - name: execute-transition
      description: ✨ Execute manual state transition
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.execute-transition
      with:
        entity_id: tools.entity_id
        entity_name: tools.entity_name
      inputParameters:
      - name: entity_id
        type: integer
        description: entity_id
        required: true
      - name: entity_name
        type: string
        description: entity_name
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: Get file upload
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio.get
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: Delete file upload
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio.delete
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: Update file upload
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio.update
      with:
        id: tools.id
      inputParameters:
      - name: id
        type: integer
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    LABEL_STUDIO_TOKEN: LABEL_STUDIO_TOKEN