Skip to main content
POST
/
test_framework
/
v1
/
scenarios
/
run_scenarios_pipecat
/
cURL
curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/scenarios/run_scenarios_pipecat/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '{
  "scenarios": [
    {
      "scenario": 123,
      "pipecat_room_url": "<string>",
      "pipecat_token": "<string>",
      "publish_data_message": "<any>"
    }
  ]
}'
{
  "id": 123,
  "agent": 123,
  "status": "pending",
  "run_as_text": false,
  "runs": {
    "id": 274,
    "status": "pending",
    "scenario": 1,
    "number": null,
    "inbound_number": "+11234567890",
    "scenario_name": "Customer Support Call (Agent Inbound = True)",
    "test_profile_data": null
  },
  "created_at": "2025-02-25T21:00:01.990052Z"
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

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

Body

Schema for the run_scenarios_pipecat endpoint, which runs scenarios using Pipecat WebRTC.

​
scenarios
object[]
required

List of scenarios to run with their Pipecat WebRTC configuration

Response

​
id
integer

ID of the result

​
agent
integer

ID of the agent

​
status
enum<string>

Status of the result

Available options:
pending,
running,
completed,
failed
​
run_as_text
boolean

Whether the scenario ran as text or not

Example:

false

​
runs
object[]
Examples:
{
  "id": 274,
  "status": "pending",
  "scenario": 1,
  "number": null,
  "inbound_number": "+11234567890",
  "scenario_name": "Customer Support Call (Agent Inbound = True)",
  "test_profile_data": null
}
{
  "id": 275,
  "status": "pending",
  "scenario": 2,
  "number": "+11234567890",
  "inbound_number": null,
  "scenario_name": "Outbound Sales Call (Agent Inbound = False)",
  "test_profile_data": null
}
​
created_at
string<date-time>
Example:

"2025-02-25T21:00:01.990052Z"