find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bugbug-io:bugbug-io-visual-regression-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: BugBug.io Public Visual regression API
  version: v2
  x-logo:
    url: /static/images/logo.svg
    altText: BugBug.io
  description: 'BugBug.io is a modern browser-based app for software testers, developers, or product managers in need of quick & reliable test automation. You can run tests from your CI/CD pipeline or build system. You can run tests and suites in the cloud via BugBug Command Line Interface.


    Please use Authorize button to Try it out.'
  contact:
    email: support@bugbug.io
tags:
- name: Visual regression
  description: Visual regression reference screenshots
paths:
  /v2/visual-regression/reference-screenshots/:
    get:
      operationId: v2_visual_regression_reference_screenshots_list
      description: Returns a list of visual regression reference screenshots.
      summary: List visual regression reference screenshots
      parameters:
      - 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
      - in: query
        name: step_id
        schema:
          type: string
        description: Filter reference screenshots by step ID.
        required: true
      tags:
      - Visual regression
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedV2VisualRegressionRefScreenshotList'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
    post:
      operationId: v2_visual_regression_reference_screenshots_create
      description: Creates a new visual regression reference screenshot.
      summary: Create visual regression reference screenshot
      tags:
      - Visual regression
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2VisualRegressionRefScreenshotCreate'
          application/json:
            schema:
              $ref: '#/components/schemas/V2VisualRegressionRefScreenshotCreate'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2VisualRegressionRefScreenshot'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
  /v2/visual-regression/reference-screenshots/{id}/:
    get:
      operationId: v2_visual_regression_reference_screenshots_retrieve
      description: Returns a single visual regression reference screenshot.
      summary: Retrieve visual regression reference screenshot
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this visual regression ref screenshot.
        required: true
      tags:
      - Visual regression
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2VisualRegressionRefScreenshot'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
    put:
      operationId: v2_visual_regression_reference_screenshots_update
      description: Updates a visual regression reference screenshot.
      summary: Update visual regression reference screenshot
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this visual regression ref screenshot.
        required: true
      tags:
      - Visual regression
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2VisualRegressionRefScreenshotUpdate'
          application/json:
            schema:
              $ref: '#/components/schemas/V2VisualRegressionRefScreenshotUpdate'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2VisualRegressionRefScreenshot'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
    patch:
      operationId: v2_visual_regression_reference_screenshots_partial_update
      description: Updates a visual regression reference screenshot.
      summary: Update visual regression reference screenshot
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this visual regression ref screenshot.
        required: true
      tags:
      - Visual regression
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedV2VisualRegressionRefScreenshotUpdate'
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedV2VisualRegressionRefScreenshotUpdate'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2VisualRegressionRefScreenshot'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
    delete:
      operationId: v2_visual_regression_reference_screenshots_destroy
      description: Deletes a visual regression reference screenshot.
      summary: Delete visual regression reference screenshot
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this visual regression ref screenshot.
        required: true
      tags:
      - Visual regression
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '204':
          description: No response body
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
  /v2/visual-regression/resolve/:
    post:
      operationId: v2_visual_regression_resolve_create
      description: Resolves failed visual regression checks. Use `set_new_reference` to accept the observed screenshot as the new baseline, or `set_new_max_difference` to raise the step's allowed difference to just above the observed value. Provide exactly one of `stepRunId` or `testRunId`.
      summary: Resolve visual regression review
      tags:
      - Visual regression
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2ResolveVisualRegression'
          application/json:
            schema:
              $ref: '#/components/schemas/V2ResolveVisualRegression'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          description: No response body
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
components:
  schemas:
    V2VisualRegressionRefScreenshotUpdate:
      type: object
      properties:
        screenshot:
          type: string
          format: uri
      required:
      - screenshot
    PaginatedV2VisualRegressionRefScreenshotList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/V2VisualRegressionRefScreenshot'
    V2ResolveVisualRegression:
      type: object
      properties:
        type:
          enum:
          - set_new_max_difference
          - set_new_reference
          type: string
          description: '* `set_new_max_difference` - Max Difference

            * `set_new_reference` - Set New Reference'
          x-spec-enum-id: e2f417ea7e0a9cd8
        testRunId:
          type: string
          format: uuid
        stepRunId:
          type: string
          format: uuid
      required:
      - type
    PatchedV2VisualRegressionRefScreenshotUpdate:
      type: object
      properties:
        screenshot:
          type: string
          format: uri
    V2VisualRegressionRefScreenshot:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        stepId:
          type: string
          format: uuid
          readOnly: true
        projectArtifactId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        screenshotUrl:
          type:
          - string
          - 'null'
          readOnly: true
        browserName:
          type:
          - string
          - 'null'
          readOnly: true
        osName:
          type:
          - string
          - 'null'
          readOnly: true
        screenSizeType:
          type:
          - string
          - 'null'
          readOnly: true
        runProfileId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        runProfileName:
          type: string
          readOnly: true
        runMode:
          enum:
          - server
          - local
          - recording
          - null
          type:
          - string
          - 'null'
          description: '* `server` - cloud

            * `local` - local

            * `recording` - recording'
          x-spec-enum-id: 396ab9b642f5073e
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
        modified:
          type: string
          format: date-time
          readOnly: true
      required:
      - browserName
      - created
      - id
      - modified
      - osName
      - projectArtifactId
      - runMode
      - runProfileId
      - runProfileName
      - screenSizeType
      - screenshotUrl
      - stepId
    V2VisualRegressionRefScreenshotCreate:
      type: object
      properties:
        stepId:
          type: string
          format: uuid
        screenshot:
          type: string
          format: uri
        browserName:
          type:
          - string
          - 'null'
        osName:
          type:
          - string
          - 'null'
        screenSizeType:
          enum:
          - desktop
          - mobile
          - custom
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `desktop` - Desktop

            * `mobile` - Mobile

            * `custom` - Custom'
          x-spec-enum-id: c0cdf94a62475084
        runProfileId:
          type:
          - string
          - 'null'
          format: uuid
        runMode:
          enum:
          - server
          - local
          - recording
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `server` - cloud

            * `local` - local

            * `recording` - recording'
          x-spec-enum-id: 396ab9b642f5073e
      required:
      - screenshot
      - stepId
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"