Voxli Voxli

Scenarios

List scenarios

Retrieve a paginated list of scenarios, to pick what to run with POST /runs/. Archived ones only with archived=true. GET /scenarios/{id}/tests lists a scenario's tests.

GET /scenarios/

Authorization

HeaderTypeDescription
Authorizationrequired
string
Header with your API key as a Bearer token: Bearer <api-key>. See Authentication.

Query parameters

NameTypeDescription
page
integer
Page number
Default: 1
limit
integer
Items per page
Default: 10
sortBy
string
First-level field to sort by
sortOrder
string
Sort order: asc or desc
Default: "desc"
archived
boolean
When true, list only archived items; default lists only non-archived items. No-op for models without an isArchived field.
Default: false

Response

  • 200Successful Response
PropertyTypeDescription
datarequired
object[]
idrequired
string
createdAt
string (date-time)
updatedAt
string (date-time)
namerequired
string
description
string
Default: ""
agents
object[]
The agents this scenario is limited to; empty means any agent
Default: []
id
string
name
string
fields
object
Values for the scenario's custom fields
Default: {}
isArchived
boolean
Default: false
totalrequired
integer
pagerequired
integer
limitrequired
integer

Scenarios

Get scenario