Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Get the cekura scenario details
Health
Agents
Agent Version Shareable Links
Configuration
Dispatch
Integrations
Knowledge Base
- GETGet knowledge base collections
- POSTCreate knowledge base collection
- DELDelete knowledge base collection
- GETGet knowledge base files
- POSTCreate knowledge base file
- POSTView knowledge base file
- DELDelete knowledge base file
- PATCHUpdate file status
- POSTGenerate presigned URL for uploading a file
- POSTAdd file to collection
- DELRemove file from collection
Phone Numbers
Testing Lab
Tools
Workflows
- GETList agent workflows
- POSTCreate agent workflow
- GETGet agent workflow
- PATCHUpdate agent workflow
- DELDelete agent workflow
- GETList workflow executions
- POSTCreate workflow execution
- GETGet workflow execution
- PUTUpdate workflow execution
- DELDelete workflow execution
- POSTCancel workflow execution
- POSTCancel workflow execution by lead ID
- POSTPause workflow execution
- POSTResume workflow execution
Get testing lab scenario by ID
Copy
curl --request GET \
--url https://prod.featherhq.com/api/v1/testing-lab/scenarios/{id} \
--header 'Authorization: Bearer <token>'Copy
{
"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": {}
}
}Testing Lab
Get testing lab scenario by ID
GET
/
api
/
v1
/
testing-lab
/
scenarios
/
{id}
Get testing lab scenario by ID
Copy
curl --request GET \
--url https://prod.featherhq.com/api/v1/testing-lab/scenarios/{id} \
--header 'Authorization: Bearer <token>'Copy
{
"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": {}
}
}⌘I