Create a new test

post

https://app.rainforestqa.com/api/1/tests

Create a new test

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

ai_mode

string

enum

Set to self-heal to turn on self-healing for snippets

Allowed:

browsers

array of strings

List of browsers that the test runs on by default; you can find a list of possible options via the client API

browsers

category

string

enum

Test category

Allowed:

connection_id

string

Connection to route test execution through (geographic location or custom tunnel)

reroute_geo

string

Deprecated: use connection_id instead

description

string

Test notes

environment_id

int32

Environment used to get initial_navigate_url (only concerns Visual Editor tests)

feature_id

int32

Test feature

login_snippet_id

int32

ID of a snippet to use for login steps at the start of AI test generation. Mutually exclusive with prompt_credentials

owner_id

int32

Test owner

priority

string

enum

Test priority

Allowed:

prompt

string

Prompt for self-healing snippets or AI generated tests

prompt_credentials

string

rfml_id

string

RFML ID for this test

site_id

int32

Tested site

start_uri

string

The path this test starts at; if present, must start with a /

state

string

enum

Defaults to enabled

Test state

Allowed:

tags

title

string

required

Test title (maximum length: 255 characters)

type

string

enum

required

The type of test to create

Allowed:

atc_settings

object

slim

boolean

Defaults to false

If true, returns less data in order to reduce latency and response size

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Test created

400Test could not be created