POST
/
test_framework
/
v1
/
scenarios-external
/
run_scenarios
curl --request POST \
  --url https://new-prod.vocera.ai/test_framework/v1/scenarios-external/run_scenarios/ \
  --header 'Content-Type: application/json' \
  --header 'X-VOCERA-API-KEY: <api-key>' \
  --data '{
  "agent_id": 123,
  "assistant_id": "<string>",
  "scenarios": [
    123
  ],
  "tags": [
    "<string>"
  ],
  "freq": 1,
  "name": "<string>"
}'
{
  "id": 167,
  "agent": 1,
  "status": "pending",
  "success_rate": 0,
  "run_as_text": false,
  "runs": [
    {
      "id": 274,
      "scenario": 1,
      "number": "+11234567890"
    },
    {
      "id": 273,
      "scenario": 2,
      "number": "+11234567891"
    }
  ],
  "created_at": "2025-02-25T21:00:01.990052Z"
}

Authorizations

​
X-VOCERA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Body

​
agent_id
integer

The AI agent this scenario is associated with

​
assistant_id
string

Alternative to agent ID - the assistant ID to use for this scenario

​
scenarios
integer[]

List of scenario IDs to run. Either scenarios or tags must be provided.

​
tags
string[]

List of tags to filter scenarios to run. Either scenarios or tags must be provided.

​
freq
integer
default:1

The frequency of the scenarios to run

​
name
string

Label text for the run_scenarios

Response

201
application/json
​
id
integer
Example:

167

​
agent
integer
Example:

1

​
status
enum<string>
Available options:
pending,
running,
completed,
failed
Example:

"pending"

​
success_rate
number
Example:

0

​
run_as_text
boolean
Example:

false

​
runs
object[]
Example:
[
  {
    "id": 274,
    "scenario": 1,
    "number": "+11234567890"
  },
  {
    "id": 273,
    "scenario": 2,
    "number": "+11234567891"
  }
]
​
created_at
string
Example:

"2025-02-25T21:00:01.990052Z"