List Simulation Suites

GET

https://api.vapi.ai/eval/simulation/suite

Returns the simulation suites for the authenticated organization.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Query parameters

assistantIdlist of stringsOptional

Filter by any assigned assistant ID. Supplying both assistant and squad filters requires both to match.

squadIdlist of stringsOptional

Filter by any assigned squad ID. Supplying both assistant and squad filters requires both to match.

namestringOptional

Search by simulation suite name

pagedoubleOptional>=1

This is the page number to return. Defaults to 1.

sortOrderenumOptional

This is the sort order for pagination. Defaults to 'DESC'.

Allowed values:

sortByenumOptional

This is the column to sort by. Defaults to 'createdAt'.

Allowed values:

limitdoubleOptional0-1000

This is the maximum number of items to return. Defaults to 100.

createdAtGtdatetimeOptional

This will return items where the createdAt is greater than the specified value.

createdAtLtdatetimeOptional

This will return items where the createdAt is less than the specified value.

createdAtGedatetimeOptional

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLedatetimeOptional

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtdatetimeOptional

This will return items where the updatedAt is greater than the specified value.

updatedAtLtdatetimeOptional

This will return items where the updatedAt is less than the specified value.

updatedAtGedatetimeOptional

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLedatetimeOptional

This will return items where the updatedAt is less than or equal to the specified value.

Response

list of objects

SimulationSuitesPaginatedResponseobject