Skip to main content
POST
/
api
/
v1
/
testing-lab
/
scenarios
/
generate
Generate testing lab scenarios
curl --request POST \
  --url https://prod.featherhq.com/api/v1/testing-lab/scenarios/generate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "agent_id": 123,
  "assistant_id": "<string>",
  "personalities": {},
  "num_scenarios": 123,
  "test_profile": 123,
  "extra_instructions": "<string>",
  "inbound_phone_number": 123,
  "first_message": "<string>",
  "generate_expected_outcomes": true,
  "tags": [
    "<string>"
  ],
  "tool_ids": [
    "<string>"
  ]
}'
[
  {
    "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

X-API-Key
string
header
required

Body

application/json
agent_id
number
required
num_scenarios
number
required
inbound_phone_number
number
required
first_message
string
required
assistant_id
string
personalities
object
test_profile
number
extra_instructions
string
generate_expected_outcomes
boolean
tags
string[]
tool_ids
string[]

Response

Scenarios generated successfully

id
number
required
name
string
required
agent
number
required
assistant_id
string
required
personality
number
required
personality_name
string
required
tags
string[]
required
runs
number[]
required
metrics
number[]
required
metric_names
string[]
required
phone_number
string
required
phone_number_queue_length
number
required
first_message
string
required
inbound_phone_number
number
required
inbound_phone_number_data
object
required
instructions
string
required
simulation_description
string
required
information_fields
object
required
expected_outcome_prompt
string
required
scenario_language
string
required
is_simulating
boolean
required