Execute prompt simulation

Executes a prompt simulation run.

POST https://api.futureagi.com/simulate/prompt-templates/{prompt_template_id}/simulations/{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

prompt_template_id UUID Required

UUID of the prompt template that owns this simulation run.

run_test_id UUID Required

UUID of the simulation run to execute.

Request body

selectAll boolean Optional

Whether to select all scenarios. Defaults to false. When true with empty scenarioIds, all scenarios run; when true with non-empty scenarioIds, listed scenarios are excluded.

scenarioIds array of string Optional

Scenario UUIDs to include (when selectAll is false) or exclude (when selectAll is true).

Response

200 OK
status string

"success" if the request succeeded.

data object

Execution details for the triggered simulation run.

message string

Human-readable confirmation message.

executionId string

UUID of the newly created test execution.

runTestId string

UUID of the simulation run that was executed.

status string

Initial execution status, typically "pending".

totalScenarios integer

Number of scenarios selected for execution.

totalCalls integer

Total number of individual calls across all selected scenarios.

scenarioIds array of string

Scenario UUIDs selected for execution.

Errors

400 Bad Request Optional

The execution could not start due to a missing or deleted prompt version, missing scenario data, or invalid evaluation configuration.

401 Unauthorized Optional

Invalid or missing authentication credentials.

404 Not Found Optional

The specified prompt template or simulation run does not exist.

500 Internal Server Error Optional

An unexpected server error occurred.

GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE