Load Testing

Create and run load tests against IVR systems with configurable concurrency profiles. Estimate consumption before running.

10 endpoints

Create a load test

POST/testing/load-tests

Create a new load test configuration.

Body Parameters

Name	Type	Required	Description
name	string	required	Display name for the load test
configId	string	required	Test configuration ID to use as the base flow
concurrency	number	required	Number of concurrent calls
totalCalls	number	required	Total number of calls to make

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Peak Load Test","configId":"cfg_abc123","concurrency":10,"totalCalls":100}' \
  https://api.nopaque.co.uk/testing/load-tests

Response

json

{
  "config": {
    "id": "lt_abc123",
    "name": "Peak Load Test",
    "configId": "cfg_abc123",
    "concurrency": 10,
    "totalCalls": 100,
    "status": "created",
    "createdAt": "2026-04-10T12: 00: 00Z"
  }
}

List load tests

GET/testing/load-tests

List all load test configurations in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/load-tests

Response

json

{
  "configs": [
    {
      "id": "lt_abc123",
      "name": "Peak Load Test",
      "concurrency": 10,
      "totalCalls": 100,
      "status": "created"
    }
  ]
}

Get a load test

GET/testing/load-tests/{id}

Get a specific load test configuration by ID. The response spreads the config fields flat and includes a `testConfig` sibling with the referenced test configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Load test ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/load-tests/lt_abc123

Response

json

{
  "id": "lt_abc123",
  "name": "Peak Load Test",
  "configId": "cfg_abc123",
  "concurrency": 10,
  "totalCalls": 100,
  "status": "created",
  "createdAt": "2026-04-10T12: 00: 00Z",
  "testConfig": {
    "id": "cfg_abc123",
    "name": "Base Flow"
  }
}

Update a load test

PUT/testing/load-tests/{id}

Update a load test configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Load test ID

Body Parameters

Name	Type	Required	Description
name	string	optional	Updated display name
concurrency	number	optional	Updated concurrency level
totalCalls	number	optional	Updated total call count

Request

bash

curl -X PUT -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"concurrency":20}' \
  https://api.nopaque.co.uk/testing/load-tests/lt_abc123

Response

json

{
  "config": {
    "id": "lt_abc123",
    "concurrency": 20,
    "updatedAt": "2026-04-10T12: 10: 00Z"
  }
}

Delete a load test

DELETE/testing/load-tests/{id}

Delete a load test configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Load test ID

Request

bash

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/load-tests/lt_abc123

Response

json

{
  "message": "Load test deleted successfully"
}

Estimate the cost of a load test

POST/testing/load-tests/estimate

Estimate the cost and duration of a load test before running it.

Body Parameters

Name	Type	Required	Description
configId	string	required	Test configuration ID
concurrency	number	required	Number of concurrent calls
totalCalls	number	required	Total number of calls

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"configId":"cfg_abc123","concurrency":10,"totalCalls":100}' \
  https://api.nopaque.co.uk/testing/load-tests/estimate

Response

json

{
  "estimatedMinutes": 15.5,
  "estimatedCost": "$4.65",
  "concurrency": 10,
  "totalCalls": 100
}

Start a load test

POST/testing/load-tests/{id}/start

Start a load test run. Initiates concurrent calls according to the configuration.

Path Parameters

Name	Type	Required	Description
id	string	required	Load test ID

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/load-tests/lt_abc123/start

Response

json

{
  "id": "lt_abc123",
  "runId": "ltrun_def456",
  "status": "running",
  "startedAt": "2026-04-10T12: 15: 00Z"
}

Abort a load test

POST/testing/load-tests/{id}/abort

Abort a running load test.

Path Parameters

Name	Type	Required	Description
id	string	required	Load test ID

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/load-tests/lt_abc123/abort

Response

json

{
  "id": "lt_abc123",
  "status": "aborted",
  "abortedAt": "2026-04-10T12: 20: 00Z"
}

Get live load test status

GET/testing/load-tests/{id}/status

Get the current status and progress of a load test run.

Path Parameters

Name	Type	Required	Description
id	string	required	Load test ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/load-tests/lt_abc123/status

Response

json

{
  "id": "lt_abc123",
  "status": "running",
  "progress": {
    "completedCalls": 45,
    "totalCalls": 100,
    "passRate": 0.93
  }
}

List load test runs

GET/testing/load-tests/runs

List all load test runs across all load tests in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/testing/load-tests/runs

Response

json

{
  "runs": [
    {
      "id": "ltrun_def456",
      "loadTestId": "lt_abc123",
      "status": "completed",
      "passRate": 0.95
    }
  ]
}