dots.v2.genAi.simulation_runs.get()
Generated on 13 Nov 2026
from DoTs version
v1.24.0
Usage
client.v2.genAi.simulation_runs.get(requestConfiguration?: RequestConfiguration<Simulation_runsRequestBuilderGetQueryParameters>): Promise<undefined | ApiListSimulationRunsOutput>Description
To list simulation runs, send a GET request to /v2/gen-ai/simulation_runs.
Parameters
scenarioSetUuidstring optionalExample:
123e4567-e89b-12d3-a456-426614174000Optional filter by scenario set.
pageinteger optionalExample:
1Page number.
perPageinteger optionalExample:
1Items per page.
statusesarray of strings optionalExample:
["SIMULATION_RUN_STATUS_RUNNING"]Filter by one or more statuses. Empty means no status filter.
- SIMULATION_RUN_STATUS_PENDING: Accepted and queued, not yet executing.
- SIMULATION_RUN_STATUS_RUNNING: Episodes are executing.
- SIMULATION_RUN_STATUS_SUCCEEDED: All episodes finished successfully.
- SIMULATION_RUN_STATUS_FAILED: The run failed, for example because of a timeout or workflow error.
- SIMULATION_RUN_STATUS_CANCELLED: The run was cancelled.
- SIMULATION_RUN_STATUS_EVALUATING: Episodes finished and an attached evaluation is running. Only reachable
when the create request included evaluation_config. When the evaluation
reaches a terminal status, its outcome is reflected in the simulation run
status.
- SIMULATION_RUN_STATUS_PARTIALLY_SUCCESSFUL: The simulation or its attached evaluation completed with a mixture of
successful and failed results.searchstring optionalExample:
example stringFree-text search across the run name and scenario set name
(case-insensitive substring match). Empty means no search.sortBystring optionalField to sort by. Defaults to creation date when unspecified.
- SIMULATION_RUN_SORT_FIELD_CREATED_AT: Sort by creation date. Default.
- SIMULATION_RUN_SORT_FIELD_NAME: Sort by customer-supplied run name (case-insensitive).
- SIMULATION_RUN_SORT_FIELD_STATUS: Sort by status using lifecycle order (pending → running → terminal).
- SIMULATION_RUN_SORT_FIELD_UPDATED_AT: Sort by last update date.sortDirectionstring optionalSort direction. Defaults to descending when unspecified.
Request Sample
Pagination
This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page query parameter:
let response = await client.v2.genAi.simulation_runs.get();
let pages = response?.links?.pages;
while (pages && "next" in pages && typeof pages.next === "string") {
const page = Number(new URL(pages.next).searchParams.get("page"));
response = await client.v2.genAi.simulation_runs.get({
queryParameters: {
page,
},
});
pages = response?.links?.pages;
}Response Example
More Information
See /v2/gen-ai/simulation_runs in the API reference for additional detail on responses, headers, parameters, and more.