GET
/
test_framework
/
v1
/
scenarios-external
/
curl --request GET \
  --url https://new-prod.vocera.ai/test_framework/v1/scenarios-external/ \
  --header 'X-VOCERA-API-KEY: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "personality_name": "<string>",
      "phone_number": "<string>",
      "expected_outcome_prompt": "<string>",
      "instructions": "<string>",
      "scenario_language": "<string>",
      "tags": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
X-VOCERA-API-KEY
string
header
required

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

Query Parameters

​
agent_id
integer

Filter evaluators by agent ID

​
assistant_id
string

Filter evaluators by assistant ID

Minimum length: 1
​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
tags
string

Comma-separated list of tags to filter evaluators by

Minimum length: 1

Response

200 - application/json

The response is of type object.