Update Run Test Components

Change the agent definition, agent version, simulator agent, scenarios, or tool evaluation setting of an existing test run. Returns the updated test run

PATCH https://api.futureagi.com/simulate/run-tests/{run_test_id}/components/

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 update.

Request body

agent_definition_id UUID Optional

UUID of the agent definition to test. The test run switches to that agent’s latest version.

version UUID Optional

UUID of the agent version to pin. It must belong to the test run’s agent definition, including one set by agent_definition_id in the same request.

simulator_agent_id UUID Optional

UUID of the simulator agent that plays the customer.

scenarios array of UUID Optional

Scenario UUIDs to run, each listed once. The list replaces the test run’s current scenarios. Send an empty array to remove them all.

enable_tool_evaluation boolean Optional

Turns tool call evaluation on or off. While it is on, the test run’s agent version must have an API key and an assistant ID for voice agents.

Send only the fields you want to change. A field not listed above is rejected with 400.

Response

200 OK
id string

UUID of the test run.

name string

Display name of the test run.

description string

Description of the test run, or empty string if none provided.

agent_definition string or null

UUID of the associated agent definition, or null if using a prompt template.

agent_version string or null

UUID of the specific agent version, or null if using the active version.

agent_definition_detail object or null

Expanded agent definition details, or null if none associated.

source_type string

Either agent_definition or prompt.

source_type_display string

Human-readable source type label.

prompt_template string or null

UUID of the associated prompt template, or null if using an agent definition.

prompt_template_detail object or null

Expanded prompt template details, or null if none associated.

prompt_version string or null

UUID of the specific prompt version, or null if none specified.

prompt_version_detail object or null

Expanded prompt version details, or null if none specified.

scenarios array of string

Array of linked scenario UUIDs.

scenarios_detail array of objects

Expanded scenario objects with full details.

dataset_row_ids array of string

Specific dataset row UUIDs this test run is restricted to. Empty array means all rows.

simulator_agent string or null

UUID of the custom simulator agent, or null if using the default.

simulator_agent_detail object or null

Expanded simulator agent details, or null if none assigned.

simulate_eval_configs array of string

Array of associated evaluation configuration UUIDs.

simulate_eval_configs_detail array of objects

Expanded evaluation configuration objects.

evals_detail array of objects

Combined evaluation details for all configured evaluations.

enable_tool_evaluation boolean

Whether tool evaluation is enabled.

created_at string

ISO 8601 creation timestamp.

updated_at string

ISO 8601 last-modified timestamp.

last_run_at string or null

ISO 8601 timestamp of the most recent execution, or null if never executed.

Errors

400 Bad Request Optional

A field is invalid or not recognized. Or tool evaluation is on for the test run after the update and its agent version has no API key or assistant ID, or the test run has no agent version (API_KEY_AND_ASSISTANT_ID_REQUIRED). This check runs on every update while tool evaluation is on, not only when the request turns it on.

401 Unauthorized Optional

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

404 Not Found Optional

The test run, agent definition, agent version, simulator agent, or one of the scenarios was not found in your organization. A scenario UUID repeated in scenarios also returns 404.

500 Internal Server Error Optional

Unexpected server error. Contact support if it persists.

GET /
Authentication
REQUEST
 
RESPONSE