Voxli Voxli

Scenarios

Get scenario

Retrieve a specific scenario by its ID.

GET /scenarios/{id}

Authorization

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

Path parameters

NameTypeDescription
idrequired
string
The id of the item to retrieve

Response

  • 200Successful Response
PropertyTypeDescription
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

Scenarios

List tests in a scenario