v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Simulations

Get all simulations

Retrieve a paginated list of all simulations.

get/simulations/batches

projectIdstring required

Project identifier

filterstring

Filter criteria for searching simulations

limitinteger

Number of items to return per page

skipinteger

Number of items to skip

sortstring

Sort order (e.g., 'name:asc', 'createdAt:desc')

nextstring

Pagination cursor for next page

previousstring

Pagination cursor for previous page

status'STOPPED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'

Filter by simulation status

timespanstring

Filter by time range (e.g., '7d', '30d', '1y')

timezonestring

Timezone for timespan filtering (e.g., 'UTC', 'America/New_York')

endPointTypestring

Filter by endpoint type

scenariosIdsstring[]

Filter by simulation references (comma-separated list of simulation IDs)

List of simulations retrieved successfully