curl --request POST \
--url https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/ \
--header 'Content-Type: application/json' \
--header 'X-CEKURA-API-KEY: <api-key>' \
--data '
{
"spec": "<unknown>",
"file": "<string>",
"agent_id": 123,
"name": "<string>",
"livekit_data": {},
"pipecat_data": {}
}
'import requests
url = "https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/"
payload = {
"spec": "<unknown>",
"file": "<string>",
"agent_id": 123,
"name": "<string>",
"livekit_data": {},
"pipecat_data": {}
}
headers = {
"X-CEKURA-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CEKURA-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: '<unknown>',
file: '<string>',
agent_id: 123,
name: '<string>',
livekit_data: {},
pipecat_data: {}
})
};
fetch('https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spec' => '<unknown>',
'file' => '<string>',
'agent_id' => 123,
'name' => '<string>',
'livekit_data' => [
],
'pipecat_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CEKURA-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/"
payload := strings.NewReader("{\n \"spec\": \"<unknown>\",\n \"file\": \"<string>\",\n \"agent_id\": 123,\n \"name\": \"<string>\",\n \"livekit_data\": {},\n \"pipecat_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CEKURA-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/")
.header("X-CEKURA-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": \"<unknown>\",\n \"file\": \"<string>\",\n \"agent_id\": 123,\n \"name\": \"<string>\",\n \"livekit_data\": {},\n \"pipecat_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CEKURA-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": \"<unknown>\",\n \"file\": \"<string>\",\n \"agent_id\": 123,\n \"name\": \"<string>\",\n \"livekit_data\": {},\n \"pipecat_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"field_name": [
"<string>"
]
}Validate Scenarios V2 JSON
Check a spec against the agent it targets: metric slugs, personalities, test profiles, channel support and every tag. Returns the plan a run would follow, with case count and estimated cost. Creates nothing and places no calls. Use this before committing a suite or opening a pull request; use scenarios_run_json to execute one.
curl --request POST \
--url https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/ \
--header 'Content-Type: application/json' \
--header 'X-CEKURA-API-KEY: <api-key>' \
--data '
{
"spec": "<unknown>",
"file": "<string>",
"agent_id": 123,
"name": "<string>",
"livekit_data": {},
"pipecat_data": {}
}
'import requests
url = "https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/"
payload = {
"spec": "<unknown>",
"file": "<string>",
"agent_id": 123,
"name": "<string>",
"livekit_data": {},
"pipecat_data": {}
}
headers = {
"X-CEKURA-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CEKURA-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: '<unknown>',
file: '<string>',
agent_id: 123,
name: '<string>',
livekit_data: {},
pipecat_data: {}
})
};
fetch('https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spec' => '<unknown>',
'file' => '<string>',
'agent_id' => 123,
'name' => '<string>',
'livekit_data' => [
],
'pipecat_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CEKURA-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/"
payload := strings.NewReader("{\n \"spec\": \"<unknown>\",\n \"file\": \"<string>\",\n \"agent_id\": 123,\n \"name\": \"<string>\",\n \"livekit_data\": {},\n \"pipecat_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CEKURA-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/")
.header("X-CEKURA-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": \"<unknown>\",\n \"file\": \"<string>\",\n \"agent_id\": 123,\n \"name\": \"<string>\",\n \"livekit_data\": {},\n \"pipecat_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cekura.ai/test_framework/v2/scenarios/validate_scenarios_json/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CEKURA-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": \"<unknown>\",\n \"file\": \"<string>\",\n \"agent_id\": 123,\n \"name\": \"<string>\",\n \"livekit_data\": {},\n \"pipecat_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"field_name": [
"<string>"
]
}Authorizations
API Key Authentication. It should be included in the header of each request.
Body
Accepts a spec as a JSON body or an uploaded file.
CI posts JSON directly; the dashboard uploads the same file the customer has
in their repo. Both land in spec.
The test-suite spec. Use this when posting JSON directly.
A .json spec file. Use this instead of 'spec' for uploads.
Agent to test. Overrides 'agent_id' in the spec, letting one spec file run against several environments.
Label for this run. Defaults to the spec's suite name.
255How to reach the agent: 'voice' for a phone call (the default), 'text' for chat, 'elevenlabs' for an ElevenLabs WebRTC session, or 'livekit_v2' or 'pipecat_v2' for their respective WebRTC sessions.
voice- voicetext- textelevenlabs- elevenlabslivekit_v2- livekit_v2pipecat_v2- pipecat_v2
voice, text, elevenlabs, livekit_v2, pipecat_v2 Optional LiveKit overrides. These apply only to this run and are not part of the portable test-suite spec.
Show child attributes
Show child attributes
Optional Pipecat Cloud overrides. These apply only to this run and are not part of the portable test-suite spec.
Show child attributes
Show child attributes
Response
{dry_run, valid, plan}