Rainforest QA tests API

openapi: 3.0.0
info:
  title: Rainforest callback tests API
  description: Nearly all interactions done in Rainforest can be done via the API. Find your API Token (for the CLIENT_TOKEN header field) on the integration settings page (https://app.rainforestqa.com/settings/integrations).
  version: '1'
servers:
- url: https://app.rainforestqa.com/api
security:
- api_key: []
tags:
- name: tests
  description: Operations about tests
paths:
  /1/tests/{test_id}/test_versions/{test_version_id}:
    get:
      summary: Get a test version
      description: Get a test version
      parameters:
      - in: path
        name: test_id
        description: A test ID
        required: true
        schema:
          type: integer
          format: int32
      - in: path
        name: test_version_id
        description: A test version ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get a test version
      tags:
      - tests
      operationId: get-test-version
  /1/tests:
    get:
      summary: List tests
      description: List tests
      parameters:
      - in: query
        name: category
        description: Only return tests with this category
        required: false
        schema:
          type: string
          enum:
          - app
          - site
      - in: query
        name: exploratory_run_id
        description: Only return created in this exploratory run
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: priority
        description: Only return tests with this priority
        required: false
        schema:
          type: string
          enum:
          - P1
          - P2
          - P3
          - ''
          - not_prioritized
      - in: query
        name: query
        description: Only return tests whose title contains, or ID matches, this string
        required: false
        schema:
          type: string
      - in: query
        name: result
        description: Only return tests with a specific result
        required: false
        schema:
          type: string
          enum:
          - passed
          - failed
          - no_result
      - in: query
        name: run_group_id
        description: Only return tests in this run group; use `-1` to filter for tests not in any run groups
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: smart_folder_id
        description: Only return tests in this saved filter
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: step_query
        description: Only return tests whose steps match this string
        required: false
        schema:
          type: string
      - in: query
        name: tests
        description: Only return tests matching this criteria. Can be comma-separated list of test ids or 'all' to return all tests
        required: false
        schema:
          type: string
      - in: query
        name: type
        description: Only return tests of this type
        required: false
        schema:
          type: string
          enum:
          - snippet
          - test
      - in: query
        name: variable
        description: Only return tests that contain given variable
        required: false
        schema:
          type: string
      - in: query
        name: embedded
        description: If true, only return tests that are embedded in other tests. If false, only return tests that are not embedded in other tests.
        required: false
        schema:
          type: boolean
      - in: query
        name: owner_id
        description: Only return tests owned by this user; use `-1` to filter for tests without an owner
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: test_language
        description: Only return tests with a specified language
        required: false
        schema:
          type: string
          enum:
          - plain_english
          - rainforest_test_language
      - in: query
        name: logic[][operation]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - and
            - or
      - in: query
        name: logic[][expression][tag]
        description: The name of the tag
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: logic[][expression][inclusive]
        description: Whether to filter for tests tagged or untagged with the given tag
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: boolean
      - in: query
        name: sort[][title]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][id]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][updated_at]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][priority]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][created_at]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][owner]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][last_run]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][environment_name]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][last_complete_run_test_completed_at]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][last_complete_run_test_run_id]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][notified_user_name]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][self_healed_at]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: sort[][status]
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asc
            - desc
      - in: query
        name: page
        description: Page of results to display
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - in: query
        name: page_size
        description: 'Number of results to return per page; maximum: 100'
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      - in: query
        name: feature_id[]
        description: Only return tests with this/these feature(s); use `-1` to filter for tests without a feature
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: site_id[]
        description: Only return tests for this/these site(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: state[]
        description: Only return tests that with this state
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - enabled
            - disabled
            - draft
            - archived
            - all
            - unarchived
      - in: query
        name: tags[]
        description: Only return tests having all specified tags; use `-1` to filter for untagged tests
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: run_id[]
        description: Only return tests that were in this/these previous run(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: options[]
        description: List of extra details to display
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - elements
            - run_tests_steps
            - wisp
      responses:
        '200':
          description: Tests retrieved
          headers:
            X-Total-Pages:
              description: Total pages
              schema:
                type: integer
            X-Current-Page:
              description: Current page
              schema:
                type: integer
            X-Per-Page:
              description: The maximum number of results per page
              schema:
                type: integer
            X-Total-Results:
              description: The total number of results
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Test'
        '400':
          description: Invalid filtering parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - tests
      operationId: get-tests
      x-rdme-order: 1
    post:
      summary: Create a new test
      description: Create a new test
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post-tests'
        required: true
      responses:
        '201':
          description: Test created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Test'
        '400':
          description: Test could not be created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - tests
      operationId: post-tests
      x-rdme-order: 2
    put:
      summary: Update multiple tests
      description: Update multiple tests
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/put-tests'
        required: true
      responses:
        '200':
          description: Tests updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ok'
        '400':
          description: Tests could not be updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - tests
      operationId: put-tests
      x-rdme-order: 3
    delete:
      summary: Delete multiple tests
      description: Delete multiple tests
      parameters:
      - in: query
        name: category
        description: Only delete tests with this category
        required: false
        schema:
          type: string
          enum:
          - app
          - site
      - in: query
        name: exploratory_run_id
        description: Only delete created in this exploratory run
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: priority
        description: Only delete tests with this priority
        required: false
        schema:
          type: string
          enum:
          - P1
          - P2
          - P3
          - ''
          - not_prioritized
      - in: query
        name: query
        description: Only delete tests whose title contains, or ID matches, this string
        required: false
        schema:
          type: string
      - in: query
        name: result
        description: Only delete tests with a specific result
        required: false
        schema:
          type: string
          enum:
          - passed
          - failed
          - no_result
      - in: query
        name: run_group_id
        description: Only delete tests in this run group; use `-1` to filter for tests not in any run groups
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: smart_folder_id
        description: Only delete tests in this saved filter
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: step_query
        description: Only delete tests whose steps match this string
        required: false
        schema:
          type: string
      - in: query
        name: tests
        description: Only delete tests matching this criteria. Can be comma-separated list of test ids or 'all' to delete all tests
        required: false
        schema:
          type: string
      - in: query
        name: type
        description: Only delete tests of this type
        required: false
        schema:
          type: string
          enum:
          - snippet
          - test
      - in: query
        name: variable
        description: Only delete tests that contain given variable
        required: false
        schema:
          type: string
      - in: query
        name: embedded
        description: If true, only delete tests that are embedded in other tests. If false, only delete tests that are not embedded in other tests.
        required: false
        schema:
          type: boolean
      - in: query
        name: owner_id
        description: Only delete tests owned by this user; use `-1` to filter for tests without an owner
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: test_language
        description: Only delete tests with a specified language
        required: false
        schema:
          type: string
          enum:
          - plain_english
          - rainforest_test_language
      - in: query
        name: async
        description: When true perform the operation asynchronously. Use when you're experiencing timeouts. There is no way to determine if the operation was successful or when it is complete.
        required: false
        schema:
          type: boolean
          default: false
      - in: query
        name: feature_id[]
        description: Only delete tests with this/these feature(s); use `-1` to filter for tests without a feature
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: site_id[]
        description: Only delete tests for this/these site(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: state[]
        description: Only delete tests that with this state
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - enabled
            - disabled
            - draft
            - archived
            - all
            - unarchived
      - in: query
        name: tags[]
        description: Only delete tests having all specified tags; use `-1` to filter for untagged tests
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: run_id[]
        description: Only delete tests that were in this/these previous run(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      responses:
        '200':
          description: Tests deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ok'
        '400':
          description: Tests could not be deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - tests
      operationId: delete-tests
      x-rdme-order: 4
  /1/tests/duplicate:
    post:
      summary: Duplicate multiple tests
      description: Duplicate multiple tests
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post-tests-duplicate'
        required: true
      responses:
        '200':
          description: Tests duplicated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ok'
        '202':
          description: Tests scheduled to be duplicated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ok'
        '400':
          description: Tests could not be duplicated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - tests
      operationId: post-tests-duplicate
      x-rdme-order: 5
  /1/tests/{test_id}/regenerate:
    put:
      summary: Regenerate a test with AI from a new prompt
      description: Regenerate a test with AI from a new prompt
      parameters:
      - in: path
        name: test_id
        description: A test ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/put-test-regenerate'
        required: true
      responses:
        '200':
          description: Test regeneration started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Test'
        '400':
          description: Test could not be regenerated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Another AI generation is already in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - tests
      operationId: put-test-regenerate
  /1/tests/tags:
    post:
      summary: Tag a group of tests
      description: Tag a group of tests
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post-tests-tags'
        required: true
      responses:
        '201':
          description: Tag a group of tests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
      tags:
      - tests
      operationId: post-tests-tags
      x-rdme-order: 7
    delete:
      summary: Remove tags from a group of tests
      description: Untag a group of tests
      parameters:
      - in: query
        name: category
        description: Only untag tests with this category
        required: false
        schema:
          type: string
          enum:
          - app
          - site
      - in: query
        name: exploratory_run_id
        description: Only untag created in this exploratory run
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: priority
        description: Only untag tests with this priority
        required: false
        schema:
          type: string
          enum:
          - P1
          - P2
          - P3
          - ''
          - not_prioritized
      - in: query
        name: query
        description: Only untag tests whose title contains, or ID matches, this string
        required: false
        schema:
          type: string
      - in: query
        name: result
        description: Only untag tests with a specific result
        required: false
        schema:
          type: string
          enum:
          - passed
          - failed
          - no_result
      - in: query
        name: run_group_id
        description: Only untag tests in this run group; use `-1` to filter for tests not in any run groups
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: smart_folder_id
        description: Only untag tests in this saved filter
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: step_query
        description: Only untag tests whose steps match this string
        required: false
        schema:
          type: string
      - in: query
        name: tests
        description: Only untag tests matching this criteria. Can be comma-separated list of test ids or 'all' to untag all tests
        required: false
        schema:
          type: string
      - in: query
        name: type
        description: Only untag tests of this type
        required: false
        schema:
          type: string
          enum:
          - snippet
          - test
      - in: query
        name: variable
        description: Only untag tests that contain given variable
        required: false
        schema:
          type: string
      - in: query
        name: embedded
        description: If true, only untag tests that are embedded in other tests. If false, only untag tests that are not embedded in other tests.
        required: false
        schema:
          type: boolean
      - in: query
        name: owner_id
        description: Only untag tests owned by this user; use `-1` to filter for tests without an owner
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: test_language
        description: Only untag tests with a specified language
        required: false
        schema:
          type: string
          enum:
          - plain_english
          - rainforest_test_language
      - in: query
        name: async
        description: When true perform the operation asynchronously. Use when you're experiencing timeouts. There is no way to determine if the operation was successful or when it is complete.
        required: false
        schema:
          type: boolean
          default: false
      - in: query
        name: untag_with
        description: List of tags to remove
        required: true
        schema:
          type: string
      - in: query
        name: feature_id[]
        description: Only untag tests with this/these feature(s); use `-1` to filter for tests without a feature
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: site_id[]
        description: Only untag tests for this/these site(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: state[]
        description: Only untag tests that with this state
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - enabled
            - disabled
            - draft
            - archived
            - all
            - unarchived
      - in: query
        name: tags[]
        description: Only untag tests having all specified tags; use `-1` to filter for untagged tests
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: run_id[]
        description: Only untag tests that were in this/these previous run(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      responses:
        '204':
          description: Untag a group of tests
      tags:
      - tests
      operationId: delete-tests-tags
      x-rdme-order: 8
  /1/tests/credit_cost:
    get:
      summary: List credit costs for a selection of tests
      description: List credit costs for a selection of tests
      parameters:
      - in: query
        name: category
        description: Only return tests with this category
        required: false
        schema:
          type: string
          enum:
          - app
          - site
      - in: query
        name: exploratory_run_id
        description: Only return created in this exploratory run
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: priority
        description: Only return tests with this priority
        required: false
        schema:
          type: string
          enum:
          - P1
          - P2
          - P3
          - ''
          - not_prioritized
      - in: query
        name: query
        description: Only return tests whose title contains, or ID matches, this string
        required: false
        schema:
          type: string
      - in: query
        name: result
        description: Only return tests with a specific result
        required: false
        schema:
          type: string
          enum:
          - passed
          - failed
          - no_result
      - in: query
        name: run_group_id
        description: Only return tests in this run group; use `-1` to filter for tests not in any run groups
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: smart_folder_id
        description: Only return tests in this saved filter
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: step_query
        description: Only return tests whose steps match this string
        required: false
        schema:
          type: string
      - in: query
        name: tests
        description: Only return tests matching this criteria. Can be comma-separated list of test ids or 'all' to return all tests
        required: false
        schema:
          type: string
      - in: query
        name: type
        description: Only return tests of this type
        required: false
        schema:
          type: string
          enum:
          - snippet
          - test
      - in: query
        name: variable
        description: Only return tests that contain given variable
        required: false
        schema:
          type: string
      - in: query
        name: embedded
        description: If true, only return tests that are embedded in other tests. If false, only return tests that are not embedded in other tests.
        required: false
        schema:
          type: boolean
      - in: query
        name: owner_id
        description: Only return tests owned by this user; use `-1` to filter for tests without an owner
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: test_language
        description: Only return tests with a specified language
        required: false
        schema:
          type: string
          enum:
          - plain_english
          - rainforest_test_language
      - in: query
        name: feature_id[]
        description: Only return tests with this/these feature(s); use `-1` to filter for tests without a feature
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: site_id[]
        description: Only return tests for this/these site(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: state[]
        description: Only return tests that with this state
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - enabled
            - disabled
            - draft
            - archived
            - all
            - unarchived
      - in: query
        name: tags[]
        description: Only return tests having all specified tags; use `-1` to filter for untagged tests
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: run_id[]
        description: Only return tests that were in this/these previous run(s)
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - in: query
        name: browsers[]
        description: Specify browsers to use for credit cost. Uses test's default browsers if omitted.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: List credit costs for a selection of tests
      tags:
      - tests
      operationId: get-tests-credit_cost
      x-rdme-order: 10
  /1/tests/{test_id}/files:
    get:
      summary: Get files for a test
      description: Get files for a test
      parameters:
      - in: path
        name: test_id
        description: A test ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Get files for a test
      tags:
      - tests
      operationId: get-test-files
      x-rdme-order: 40
    post:
      summary: Create a new file for a test
      description: Create a new file for a test
      parameters:
      - in: path
        name: test_id
        description: A test ID
        required: true
        schema:
          type: integer
          format: int3

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rainforest-qa/refs/heads/main/openapi/rainforest-qa-tests-api-openapi.yml