simulate

Create a new RunTest

post/simulate/run-tests/create/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/simulate/run-tests/create/
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in header X-Secret-Key

Request body

namestring required
descriptionstring
agent_definition_idstring uuid required
scenario_idsstring[] required
dataset_row_idsstring[]
eval_config_idsstring[]
enable_tool_evaluationboolean

Enable automatic tool evaluation for this test run

replay_session_idstring uuid nullable

Optional replay session ID to mark as completed after run test creation

agent_versionstring uuid nullable

Optional agent version to bind to this test run

Response

Created

idstring uuid
namestring

Name of the test run

descriptionstring nullable
agent_definitionstring uuid nullable

Agent definition for this test run

agent_versionobject nullable
agent_definition_detailobject nullable
source_type'agent_definition' | 'prompt'

Source type for the test run: agent_definition or prompt

source_type_displaystring nullable
prompt_templatestring uuid nullable

Prompt template for this test run (only for prompt source type)

prompt_template_detailobject nullable
prompt_versionstring uuid nullable

Prompt version for this test run (only for prompt source type)

prompt_version_detailobject nullable
scenariosstring[]

Scenarios to run in this test

scenarios_detailobject[]
dataset_row_idsstring[]

IDs of dataset rows to run evaluations on

simulator_agentstring uuid nullable

Simulator agent for this test run (derived from scenarios)

simulator_agent_detailobject nullable
simulate_eval_configsstring[]
organizationstring uuid

Organization this test run belongs to

enable_tool_evaluationboolean

Enable automatic tool evaluation for this test run

created_atstring date-time
updated_atstring date-time
last_run_atstring date-time nullable
deletedboolean
deleted_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.