Simulations
Get all scenarios
Retrieve a paginated list of scenarios for the authenticated user’s organization and project.
GET
/
simulations
Get all scenarios
curl --request GET \
--url https://api-trial.cognigy.ai/testing/simulations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-trial.cognigy.ai/testing/simulations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-trial.cognigy.ai/testing/simulations', 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-trial.cognigy.ai/testing/simulations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/testing/simulations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/testing/simulations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/simulations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"referenceId": "<string>",
"name": "<string>",
"persona": "<string>",
"personaName": "<string>",
"mission": "<string>",
"successCriteria": [
{
"type": "<string>",
"params": {}
}
],
"organisationReference": "<string>",
"projectReference": "<string>",
"createdAt": 123,
"createdBy": "<string>",
"lastChanged": 123,
"lastChangedBy": "<string>",
"maxTurns": 123,
"timeout": 123,
"aiAgentReferenceId": "<string>",
"aiAgentId": "<string>",
"flowReferenceId": "<string>",
"flowId": "<string>",
"jobNodeId": "<string>",
"updatedAt": 123,
"updatedBy": "<string>",
"nextScheduledRun": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"skip": 123,
"total": 123,
"hasNext": true,
"hasPrevious": true,
"next": "<string>",
"previous": "<string>"
}
}{
"error": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}Authorizations
bearerAuthapiKeyAuth
JWT Bearer Token for authentication
Query Parameters
Project identifier
Filter criteria for searching scenarios
Number of items to return per page
Required range:
1 <= x <= 100Number of items to skip
Required range:
x >= 0Sort order (e.g., 'name:asc', 'createdAt:desc')
Pagination cursor for next page
Pagination cursor for previous page
When true, each scenario in the response is enriched with the nextScheduledRun of its soonest upcoming enabled schedule (or null if no upcoming schedule exists). Any value other than the literal true is treated as false and the field is omitted.
Last modified on July 2, 2026
⌘I
Get all scenarios
curl --request GET \
--url https://api-trial.cognigy.ai/testing/simulations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-trial.cognigy.ai/testing/simulations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-trial.cognigy.ai/testing/simulations', 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-trial.cognigy.ai/testing/simulations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/testing/simulations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/testing/simulations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/simulations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"referenceId": "<string>",
"name": "<string>",
"persona": "<string>",
"personaName": "<string>",
"mission": "<string>",
"successCriteria": [
{
"type": "<string>",
"params": {}
}
],
"organisationReference": "<string>",
"projectReference": "<string>",
"createdAt": 123,
"createdBy": "<string>",
"lastChanged": 123,
"lastChangedBy": "<string>",
"maxTurns": 123,
"timeout": 123,
"aiAgentReferenceId": "<string>",
"aiAgentId": "<string>",
"flowReferenceId": "<string>",
"flowId": "<string>",
"jobNodeId": "<string>",
"updatedAt": 123,
"updatedBy": "<string>",
"nextScheduledRun": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"skip": 123,
"total": 123,
"hasNext": true,
"hasPrevious": true,
"next": "<string>",
"previous": "<string>"
}
}{
"error": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}