Skip to main content
GET
/
api
/
v1
/
testing-lab
/
scenarios
/
{id}
Get testing lab scenario by ID
curl --request GET \
  --url https://prod.featherhq.com/api/v1/testing-lab/scenarios/{id} \
  --header 'X-API-Key: <api-key>'
{
  "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>",
    "common": "<string>"
  },
  "instructions": "<string>",
  "simulation_description": "<string>",
  "information_fields": {},
  "expected_outcome_prompt": "<string>",
  "scenario_language": "<string>",
  "test_profile": 123,
  "test_profile_data": {
    "id": 123,
    "agent": 123,
    "name": "<string>",
    "information": {}
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Response

Get the cekura scenario details

id
number
required
name
string
required
agent
number
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
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
test_profile
number
required
test_profile_data
object
required
tool_ids
any