Simulation Suites

List Simulation Suites

Returns a pagination envelope when page, limit, name, assistantId, or squadId is supplied; otherwise returns the legacy array.

get/eval/simulation/suite

Request

  • Base URL
    https://api.vapi.ai
  • Auth
    HTTP bearer

Query parameters

assistantIdstring[]

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

squadIdstring[]

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

namestring

Search by simulation suite name

pagenumber

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

sortOrder'ASC' | 'DESC'

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

sortBy'createdAt' | 'duration' | 'cost'

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

limitnumber

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

createdAtGtstring date-time

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

createdAtLtstring date-time

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

createdAtGestring date-time

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

createdAtLestring date-time

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

updatedAtGtstring date-time

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

updatedAtLtstring date-time

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

updatedAtGestring date-time

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

updatedAtLestring date-time

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

Response

OR

Example response

[
  {
    "name": "Checkout Flow Tests"
  }
]

Changes

No operation changes found yet. Some revisions have not been checked.