Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rainforest QA tests API

Operations about tests

Rainforest QA tests API is one of 18 APIs that Rainforest QA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include tests. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 19 operations across 12 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 1.

Requests are made against a single base URL, https://app.rainforestqa.com/api.

19 operations 12 paths 18 schemas 3 DELETE9 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1
Base URL
https://app.rainforestqa.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rainforest QA tests API declares 1 security scheme for authenticating requests. An API key is passed in the header as CLIENT_TOKEN (api_key). By default, every request must be authenticated.

Paths & Operations 19

Across 12 paths, the API surfaces 19 operations — 3 DELETE, 9 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

tests 19

Operations about tests

GET
/1/tests/{test_id}/test_versions/{test_version_id}
Get a test version
get-test-version 2 params → 200
GET
/1/tests
List tests
get-tests 38 params → 200400
POST
/1/tests
Create a new test
post-tests body → 201400
PUT
/1/tests
Update multiple tests
put-tests body → 200400
DELETE
/1/tests
Delete multiple tests
delete-tests 20 params → 200400
POST
/1/tests/duplicate
Duplicate multiple tests
post-tests-duplicate body → 200202400
PUT
/1/tests/{test_id}/regenerate
Regenerate a test with AI from a new prompt
put-test-regenerate 1 param body → 200400409
POST
/1/tests/tags
Tag a group of tests
post-tests-tags body → 201
DELETE
/1/tests/tags
Remove tags from a group of tests
delete-tests-tags 21 params → 204
GET
/1/tests/credit_cost
List credit costs for a selection of tests
get-tests-credit_cost 20 params → 200
GET
/1/tests/{test_id}/files
Get files for a test
get-test-files 1 param → 200
POST
/1/tests/{test_id}/files
Create a new file for a test
post-test-files 1 param body → 201
GET
/1/tests/{test_id}
Get a test
get-test 6 params → 200
PUT
/1/tests/{test_id}
Update a test
put-test 1 param body → 200
DELETE
/1/tests/{test_id}
Delete a test
delete-test 1 param → 204
GET
/1/tests/{test_id}/comments
Comment history for a test
get-test-comments 3 params → 200
GET
/1/tests/{test_id}/history
Run history for a test
get-test-history 3 params → 200
GET
/1/tests/{test_id}/automation_history
Run and generation history for a test
get-test-run-and-generation-history 3 params → 200
GET
/1/tests/{test_id}/run_group_elements
Get list of run group elements directly or indirectly linked to the test
get-test-run_group_elements 1 param → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Test (51 properties), put-tests (28 properties), put-test-regenerate (22 properties), post-tests (22 properties). Each schema is shown below with its type and property counts.

put-test-regenerate
object
Regenerate a test with AI from a new prompt
22 properties
Tests_Lite
object
16 properties
RunGroupElement
object
RunGroupElement model
6 properties
post-test-files
object
Create a new file for a test
4 properties 2 required
Error
object
Error model
1 property 1 required
OverriddenResult
object
6 properties
Ok
object
Ok model
1 property
post-tests
object
Create a new test
22 properties 2 required
Tag
object
Tag model
3 properties
UserLite
object
6 properties
put-test
object
Update a test
22 properties
Test
object
Test model
51 properties
Connection
object
Connection model
7 properties
RunSuperLite
object
3 properties
RunTestBrowserStatus
object
9 properties
post-tests-tags
object
Tag a group of tests
21 properties 1 required
put-tests
object
Update multiple tests
28 properties
post-tests-duplicate
object
Duplicate multiple tests
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-qa-tests-api-openapi.yml Raw ↑

Other APIs Rainforest QA publishes across the network.

Rainforest QA callback API
Rainforest QA clients API
Rainforest QA connections API
Rainforest QA credit_cards API
Rainforest QA environments API
Rainforest QA features API
Rainforest QA folders API
Rainforest QA generators API
Rainforest QA on_premise_crowd API
Rainforest QA run_groups API
Rainforest QA runs API
Rainforest QA site_environments API