Execute a test run

Executes a test run.

POST https://api.futureagi.com/simulate/run-tests/{run_test_id}/execute/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Path parameters

run_test_id UUID Required

UUID of the test run to execute. The test run must have at least one scenario associated.

Request body

selectAll boolean Optional

When true, all scenarios run except those in scenarioIds (exclusion mode). When false, only those in scenarioIds run (inclusion mode).

scenarioIds array of string Optional

Array of scenario UUIDs to include or exclude based on selectAll. If empty, all scenarios run.

simulatorId string Optional

UUID of a simulator agent to use. Defaults to the test run or organization default if omitted.

Response

200 OK
message string

Confirmation that execution was queued.

execution_id string

UUID of the created execution instance.

run_test_id string

UUID of the parent test run.

status string

Initial status, always "PENDING". Transitions through RUNNING to COMPLETED, FAILED, or CANCELLED.

total_scenarios integer

Number of scenarios that will be executed after filtering.

total_calls integer

Total simulation calls across all selected scenarios.

scenario_ids array of string

Resolved list of scenario UUIDs that will be executed.

Errors

400 Bad Request Optional

Test run has no scenarios, contains invalid scenario IDs, or has a misconfigured agent/eval setup.

401 Unauthorized Optional

Missing or invalid X-Api-Key or X-Secret-Key headers.

404 Not Found Optional

Test run or organization not found.

500 Internal Server Error Optional

Unexpected server error. Contact support if it persists.

GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE