For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Skip to main content
Phone Testing›Create Suite
TestMu AI
StatusCommunityBlog
Selenium Automation API
Automated Screenshots API
App Automation API (Real Devices)
Smart UI
Cypress Automation
User Management
Test Manager
HyperExecute
Accessibility Testing
Analytics
Performance Testing
Audit logs
Agent Testing API
Phone Testing

Create Suite

Create a new suite.

POST
/api/suites
Create Suite
curl --request POST \
  --url "https://agent-testing.lambdatest.com/api/suites" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "project_id": "<project_id>",
    "workflow_id": "<workflow_id>",
    "name": "<name>",
    "scenario_ids": [],
    "scenarios": [],
    "test_profile_id": "<test_profile_id>",
    "agent_profile_id": "<agent_profile_id>",
    "region": "<region>",
    "passive_mode": true
  }'
{
  "id": "<string>",
  "project_id": "<string>",
  "workflow_id": "<string>",
  "name": "<string>",
  "scenario_ids": [
    {}
  ],
  "has_active_scheduler": false,
  "scheduler_id": "<string>",
  "test_profile_id": "<string>",
  "agent_profile_id": "<string>",
  "region": "<string>"
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
project_idstringrequired
workflow_idstring
namestringrequired
scenario_idsarrayrequired
scenariosarray
test_profile_idstring

Optional test profile ID to associate with this suite

agent_profile_idstring

Optional agent profile ID to associate with this suite

regionstring

Inbound region for every scenario in this suite (e.g. 'us', 'eu'). Null = inherit default 'us'. Scenario-level region overrides this.

passive_modeboolean

Response

application/json

Successful Response

idstringrequired
project_idstringrequired
workflow_idstring
namestringrequired
scenario_idsarrayrequired
has_active_schedulerboolean
scheduler_idstring
test_profile_idstring

Optional test profile ID associated with this suite

agent_profile_idstring

Optional agent profile ID associated with this suite

regionstring

Inbound region for this suite (e.g. 'us', 'eu')

Create Suite
curl --request POST \
  --url "https://agent-testing.lambdatest.com/api/suites" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "project_id": "<project_id>",
    "workflow_id": "<workflow_id>",
    "name": "<name>",
    "scenario_ids": [],
    "scenarios": [],
    "test_profile_id": "<test_profile_id>",
    "agent_profile_id": "<agent_profile_id>",
    "region": "<region>",
    "passive_mode": true
  }'
{
  "id": "<string>",
  "project_id": "<string>",
  "workflow_id": "<string>",
  "name": "<string>",
  "scenario_ids": [
    {}
  ],
  "has_active_scheduler": false,
  "scheduler_id": "<string>",
  "test_profile_id": "<string>",
  "agent_profile_id": "<string>",
  "region": "<string>"
}