POST
/
test_framework
/
v1
/
scenarios-external
/
curl --request POST \
  --url https://new-prod.vocera.ai/test_framework/v1/scenarios-external/ \
  --header 'Content-Type: application/json' \
  --header 'X-VOCERA-API-KEY: <api-key>' \
  --data '{
  "agent": 123,
  "assistant_id": "<string>",
  "name": "<string>",
  "personality": 123,
  "instructions": "<string>",
  "expected_outcome_prompt": "<string>",
  "metrics": {},
  "tags": [
    "<string>"
  ],
  "tool_ids": [
    "<string>"
  ]
}'
{
  "id": 123,
  "name": "<string>",
  "agent": 123,
  "personality": 123,
  "personality_name": "<string>",
  "tags": [
    "<string>"
  ],
  "tool_ids": "<any>",
  "runs": [
    123
  ],
  "metrics": [
    123
  ],
  "metric_names": [
    "<string>"
  ],
  "phone_number": "<string>",
  "first_message": "<string>",
  "inbound_phone_number": 123,
  "inbound_phone_number_data": {
    "id": 123,
    "number": "<string>",
    "phone_number_id": "<string>"
  },
  "instructions": "<string>",
  "simulation_description": "<string>",
  "information_fields": {},
  "expected_outcome_prompt": "<string>",
  "scenario_language": "ar"
}

Authorizations

X-VOCERA-API-KEY
string
header
required

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

Body

Response

201
application/json

The response is of type object.