Skip to main content
POST
/
simulate
/
run-tests
/
{run_test_id}
/
execute
curl --request POST \
  --url https://api.futureagi.com/simulate/run-tests/{run_test_id}/execute/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>' \
  --data '
{
  "selectAll": false,
  "scenarioIds": [
    "<scenario_id>"
  ]
}
'
{
  "message": "Test execution started successfully",
  "execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_test_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "PENDING",
  "total_scenarios": 123,
  "total_calls": 123,
  "scenario_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

​
X-Api-Key
string
header
required

API Key for authentication. Click here to access API Key

​
X-Secret-Key
string
header
required

Secret Key for authentication. Click here to access Secret Key

Path Parameters

​
run_test_id
string<uuid>
required

The UUID of the test run to execute.

Body

application/json

Configuration for the test execution, specifying which scenarios to run.

​
selectAll
boolean
default:false

Determines how scenarioIds is interpreted. If true, all scenarios except those in scenarioIds will be executed. If false, only the scenarios in scenarioIds will be executed. If scenarioIds is empty, all scenarios will run regardless of this flag.

​
scenarioIds
string<uuid>[]

A list of scenario UUIDs to either include or exclude from the execution, based on the selectAll flag.

​
simulatorId
string<uuid> | null

An optional UUID of a specific simulator to use for the test run.

Response

Test execution started successfully.

​
message
string
Example:

"Test execution started successfully"

​
execution_id
string<uuid>
​
run_test_id
string<uuid>
​
status
string
Example:

"PENDING"

​
total_scenarios
integer
​
total_calls
integer
​
scenario_ids
string<uuid>[]