Rainforest QA generators 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 generators. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes
11 operations
across 5 paths,
and defines 10 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.
11 operations5 paths10 schemas2 DELETE4 GET3 POST2 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 generators 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 11
Across 5 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
generators 11
Operations about generators
GET
/1/generators
List generators
get-generators5 params→ 200
POST
/1/generators
Create a new generator
post-generatorsbody→ 201400
GET
/1/generators/{generator_id}
Get a generator
get-generator2 params→ 200404
PUT
/1/generators/{generator_id}
Update a generator
put-generator1 parambody→ 200400404
DELETE
/1/generators/{generator_id}
Delete a generator
delete-generator2 params→ 200400404
GET
/1/generators/{generator_id}/rows
List generator rows
get-generator-rows4 params→ 200202302400404
POST
/1/generators/{generator_id}/rows
Create a new generator row
post-generator-rows1 parambody→ 201400404
POST
/1/generators/{generator_id}/rows/batch
Create multiple generator rows
post-generator-rows-batch1 parambody→ 201400404
GET
/1/generators/{generator_id}/rows/{row_id}
Get a generator row
get-generator-row2 params→ 200404
PUT
/1/generators/{generator_id}/rows/{row_id}
Update a generator row
put-generator-row2 paramsbody→ 200400404
DELETE
/1/generators/{generator_id}/rows/{row_id}
Delete a generator row
delete-generator-row2 params→ 200400404
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Generator (14 properties), post-generators (8 properties), put-generator (8 properties), GeneratorColumn (3 properties). Each schema is shown below with its type and property counts.
post-generators
object
Create a new generator
8 properties2 required
post-generator-rows-batch
object
Create multiple generator rows
1 property1 required
put-generator
object
Update a generator
8 properties
Generator
object
Generator model
14 properties
Ok
object
Ok model
1 property
Error
object
Error model
1 property1 required
GeneratorRow
object
GeneratorRow model
2 properties
put-generator-row
object
Update a generator row
1 property1 required
GeneratorColumn
object
3 properties
post-generator-rows
object
Create a new generator row
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
