Get scenario by ID - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

GET

/simulations/{simulationReference}

Try it

Get scenario by ID

cURL

curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference} \
  --header 'Authorization: Bearer <token>'

Python

import requests

url = "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-trial.cognigy.ai/testing/simulations/{simulationReference}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}",
  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 sort;:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}"

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))
}

Java (Unirest)

HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}")

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

Response Status Codes

Response Structure

Successful Response

{
  "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>"
}

Error Response

{
  "error": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}