CVAT Consensus API

openapi: 3.2.0
info:
  title: CVAT REST Consensus API
  version: 2.79.0 (2.0)
  description: REST API for Computer Vision Annotation Tool (CVAT)
  termsOfService: https://www.google.com/policies/terms/
  contact:
    name: CVAT.ai team
    url: https://github.com/cvat-ai/cvat
    email: support@cvat.ai
  license:
    name: MIT License
    url: https://en.wikipedia.org/wiki/MIT_License
tags:
- name: consensus
paths:
  /api/consensus/merges:
    post:
      operationId: consensus_create_merge
      summary: Create a consensus merge
      tags:
      - consensus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsensusMergeCreateRequest'
      security:
      - tokenAuth: []
      - accessTokenAuth: []
      - sessionAuth: []
        csrfAuth: []
        csrfHeaderAuth: []
      - basicAuth: []
      responses:
        '202':
          content:
            application/vnd.cvat+json:
              schema:
                $ref: '#/components/schemas/RqId'
          description: 'A consensus merge request has been enqueued, the request id is returned.

            The request status can be checked by using common requests API: GET /api/requests/<rq_id>

            '
        '400':
          description: Invalid or failed request, check the response data for details
  /api/consensus/settings:
    get:
      operationId: consensus_list_settings
      summary: List consensus settings instances
      parameters:
      - name: X-Organization
        in: header
        description: 'Organization unique slug.

          If omitted, results from all organizations available to the user are returned

          (unfiltered). An empty value ("") selects the personal sandbox workspace only.

          A non-empty value selects that organization.

          '
        schema:
          type: string
        allowEmptyValue: true
      - name: filter
        required: false
        in: query
        description: "\nJSON Logic filter. This filter can be used to perform complex filtering by grouping rules.\n\nFor example, using such a filter you can get all resources created by you:\n\n    - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}\n\nDetails about the syntax used can be found at the link: https://jsonlogic.com/\n\n Available filter_fields: ['id', 'task_id']."
        schema:
          type: string
      - name: org
        in: query
        description: 'Organization unique slug.

          If omitted, results from all organizations available to the user are returned

          (unfiltered). An empty value ("") selects the personal sandbox workspace only.

          A non-empty value selects that organization.

          '
        schema:
          type: string
        allowEmptyValue: true
      - name: org_id
        in: query
        description: 'Organization unique id.

          If omitted, results from all organizations available to the user are returned

          (unfiltered). An empty value ("") selects the personal sandbox workspace only.

          A positive integer selects that organization.

          '
        schema:
          type: integer
        allowEmptyValue: true
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: sort
        required: false
        in: query
        description: 'Which field to use when ordering the results. Available ordering_fields: [''id'']'
        schema:
          type: string
      - name: task_id
        in: query
        description: A simple equality filter for the task_id field
        schema:
          type: integer
      tags:
      - consensus
      security:
      - tokenAuth: []
      - accessTokenAuth: []
      - sessionAuth: []
        csrfAuth: []
        csrfHeaderAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/vnd.cvat+json:
              schema:
                $ref: '#/components/schemas/PaginatedConsensusSettingsList'
          description: ''
  /api/consensus/settings/{id}:
    get:
      operationId: consensus_retrieve_settings
      summary: Get consensus settings instance details
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: An id of a consensus settings instance
        required: true
      tags:
      - consensus
      security:
      - tokenAuth: []
      - accessTokenAuth: []
      - sessionAuth: []
        csrfAuth: []
        csrfHeaderAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/vnd.cvat+json:
              schema:
                $ref: '#/components/schemas/ConsensusSettings'
          description: ''
    patch:
      operationId: consensus_partial_update_settings
      summary: Update a consensus settings instance
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: An id of a consensus settings instance
        required: true
      tags:
      - consensus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedConsensusSettingsRequest'
      security:
      - tokenAuth: []
      - accessTokenAuth: []
      - sessionAuth: []
        csrfAuth: []
        csrfHeaderAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/vnd.cvat+json:
              schema:
                $ref: '#/components/schemas/ConsensusSettings'
          description: ''
components:
  schemas:
    PaginatedConsensusSettingsList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ConsensusSettings'
    RqId:
      type: object
      properties:
        rq_id:
          type: string
          description: Request id
      required:
      - rq_id
    ConsensusMergeCreateRequest:
      type: object
      properties:
        task_id:
          type: integer
          writeOnly: true
        job_id:
          type: integer
          writeOnly: true
    ConsensusSettings:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        task_id:
          type: integer
          readOnly: true
        iou_threshold:
          type: number
          format: double
          maximum: 1
          minimum: 0
          description: Pairwise annotation matching IoU threshold
    PatchedConsensusSettingsRequest:
      type: object
      properties:
        iou_threshold:
          type: number
          format: double
          maximum: 1
          minimum: 0
          description: Pairwise annotation matching IoU threshold
  securitySchemes:
    accessTokenAuth:
      type: http
      scheme: bearer
      description: 'To authenticate using an API Access token, you need to include

        the ''Authentication'' header with the ''Bearer '' prefix


        An API Access token has to be issued in the user profile section of the UI or

        via the /auth/access_tokens API before this authentication method can be used.

        '
    basicAuth:
      type: http
      scheme: basic
    csrfAuth:
      type: apiKey
      in: cookie
      name: csrftoken
      description: 'A CSRF protection token. Can be received in the ''csrftoken'' cookie in the

        server response on the /api/auth/login endpoint. The ''Origin'' header

        must also be specified in the request.

        '
    csrfHeaderAuth:
      type: apiKey
      in: header
      name: X-CSRFToken
      description: 'A CSRF protection token. Can be received in the ''csrftoken'' cookie in the

        server response on the /api/auth/login endpoint. The ''Origin'' header

        must also be specified in the request.

        '
    sessionAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Deprecated.


        You can obtain an API key (the token) from the server response on

        the /api/auth/login/ endpoint.

        '
      x-token-prefix: Token
externalDocs:
  description: CVAT documentation
  url: https://docs.cvat.ai/docs/
x-provenance:
  method: harvested
  publisher: CVAT
  source: https://app.cvat.ai/api/schema/
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)