simulate

Create a new prompt-based simulation run.

Request Body:

  • name: Name of the simulation run
  • description: Optional description
  • prompt_version_id: The prompt version to use
  • scenario_ids: List of scenario IDs to run
  • dataset_row_ids: Optional list of specific row IDs
  • evaluations_config: Optional evaluation configurations
  • enable_tool_evaluation: Optional boolean to enable tool evaluation
post/simulate/prompt-templates/{prompt_template_id}/simulations/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/simulate/prompt-templates/{prompt_template_id}/simulations/
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in header X-Secret-Key

Request body

namestring required
descriptionstring
prompt_version_idstring required

Prompt version ID (UUID) or template_version string

scenario_idsstring[] required
dataset_row_idsstring[]
enable_tool_evaluationboolean

Enable automatic tool evaluation for this simulation run

Response

Created

statusboolean

Changes

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