API Reference
- Calls
- Agents
- Metrics
- Evaluators
- Results
- Runs
- Personalities
- Predefined Metrics
- Phone Numbers
Evaluators
Generate Evaluator
Generate scenarios for a given agent
POST
/
test_framework
/
v1
/
scenarios-external
/
generate
/
Copy
Ask AI
curl --request POST \
--url https://new-prod.vocera.ai/test_framework/v1/scenarios-external/generate/ \
--header 'Content-Type: application/json' \
--header 'X-VOCERA-API-KEY: <api-key>' \
--data '{
"agent_id": 123,
"assistant_id": "<string>",
"personalities": {},
"num_scenarios": 50,
"information_fields": {},
"extra_instructions": "<string>",
"inbound_phone_number": 123,
"first_message": "Hello",
"generate_expected_outcomes": false,
"tags": [
"<string>"
],
"tool_ids": [
"<string>"
]
}'
Copy
Ask AI
[
{
"id": 123,
"name": "<string>",
"agent": 123,
"assistant_id": "<string>",
"personality": 123,
"personality_name": "<string>",
"tags": [
"<string>"
],
"runs": [
123
],
"metrics": [
123
],
"metric_names": [
"<string>"
],
"phone_number": "<string>",
"phone_number_queue_length": 123,
"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": "<string>",
"is_simulating": true
}
]
Authorizations
API Key Authentication. It should be included in the header of each request.
Body
Response
201
application/json
The response is of type object[]
.
Copy
Ask AI
curl --request POST \
--url https://new-prod.vocera.ai/test_framework/v1/scenarios-external/generate/ \
--header 'Content-Type: application/json' \
--header 'X-VOCERA-API-KEY: <api-key>' \
--data '{
"agent_id": 123,
"assistant_id": "<string>",
"personalities": {},
"num_scenarios": 50,
"information_fields": {},
"extra_instructions": "<string>",
"inbound_phone_number": 123,
"first_message": "Hello",
"generate_expected_outcomes": false,
"tags": [
"<string>"
],
"tool_ids": [
"<string>"
]
}'
Copy
Ask AI
[
{
"id": 123,
"name": "<string>",
"agent": 123,
"assistant_id": "<string>",
"personality": 123,
"personality_name": "<string>",
"tags": [
"<string>"
],
"runs": [
123
],
"metrics": [
123
],
"metric_names": [
"<string>"
],
"phone_number": "<string>",
"phone_number_queue_length": 123,
"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": "<string>",
"is_simulating": true
}
]
Assistant
Responses are generated using AI and may contain mistakes.