doctl gradient simulation-run create
Generated on 1 Sep 2026
from doctl version
v1.168.0
Usage
doctl gradient simulation-run create [flags]Aliases
cDescription
Starts a simulation of a scenario set against an agent and returns: - The simulation run UUID - The simulation run name - The simulation run status - The UUID of the scenario set being run - The UUID of the candidate agent under test - The total number of journeys and how many have finished - The simulation run creation timestamp
Example
The following example runs a scenario set against an agent:
doctl gradient simulation-run create --scenario-set-uuid f81d4fae-7dec-11d0-a765-00a0c91e6bf6 --agent-uuid 99a1cbc7-b1b2-4a0d-9c1f-9b9d2b8f9d1e --name nightly-regressionFlags
| Option | Description |
|---|---|
--agent-deployment-uuid |
The deployment UUID of the agent under test. |
--agent-name |
The display name of the agent under test. |
--agent-uuid |
The UUID of the agent under test. (required) |
--exploration-budget |
The number of journeys to run per scenario. Default: 0 |
--format |
Columns for output in a comma-separated list. Possible values: UUID, Name, Status, ScenarioSetUUID, AgentUUID, TotalJourneys, JourneysFinished, CreatedAt. |
--help, -h |
Help for this command |
--judge-model-uuid |
The UUID of the model that judges each journey. |
--max-turns |
The maximum number of conversation turns per journey. Default: 0 |
--metric-uuids |
The UUIDs of evaluation metrics to score the run with. |
--name |
The name of the simulation run. |
--no-header |
Return raw data with no headers Default: false |
--scenario-set-uuid |
The UUID of the scenario set to run. (required) |
--star-metric-name |
The name of the star metric for the run. |
--star-metric-success-threshold |
The success threshold of the star metric. Default: 0 |
--star-metric-uuid |
The UUID of the star metric for the run. |
--user-simulator-config |
A JSON object of user simulator settings. |
--user-simulator-model-uuid |
The UUID of the model that simulates the user. |
Related Commands
| Command | Description |
|---|---|
| doctl gradient simulation-run | Display commands that manage Gradient AI simulation runs. |
Global Flags
| Option | Description |
|---|---|
--access-token, -t |
API V2 access token |
--api-url, -u |
Override default API endpoint |
--config, -c |
Specify a custom config file Default: |
--context |
Specify a custom authentication context name |
--http-retry-max |
Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5 |
--http-retry-wait-max |
Set the minimum number of seconds to wait before retrying a failed request
Default: 30 |
--http-retry-wait-min |
Set the maximum number of seconds to wait before retrying a failed request
Default: 1 |
--interactive |
Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false |
--output, -o |
Desired output format [text|json] Default: text |
--trace |
Show a log of network activity while performing a command Default: false |
--verbose, -v |
Enable verbose output Default: false |