## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.cognigy.com/llms.txt)

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

### Get simulation run by ID

**GET** /simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs/{simulationRunReference}

#### Try it

**cURL**

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

**Python**

```python
import requests

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

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

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

print(response.text)
```

**JavaScript (Fetch)**

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

fetch('https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs/{simulationRunReference}', 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}/batches/{simulationRunBatchReference}/runs/{simulationRunReference}",
  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;
}
```

**Go**

```go
package main

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

func main() {
	url := "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs/{simulationRunReference}"

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

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

**Ruby**

```ruby
require 'uri'
require 'net/http'

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

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 Codes

- **200**: Simulation run retrieved successfully
- **400**: Bad request
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not Found
- **500**: Internal Server Error

### Response Structure

**Success Response**
```json
{
  "id": "<string>",
  "organisationReference": "<string>",
  "projectReference": "<string>",
  "simulationReference": "<string>",
  "simulationRunBatchReference": "<string>",
  "sequence": 123,
  "largeLanguageModelReferenceId": "<string>",
  "turns": [
    {
      "id": "<string>",
      "sequence": 123,
      "text": "<string>",
      "data": {},
      "createdAt": 123
    }
  ],
  "totalTurns": 123,
  "successCriteria": [
    {
      "type": "<string>",
      "params": {}
    }
  ],
  "metrics": {
    "success": true,
    "results": [
      {}
    ],
    "successRate": {
      "percentage": 123,
      "numerator": 123,
      "denominator": 123
    },
    "summary": "<string>",
    "isBatchStopped": true,
    "isConversationEnded": true,
    "errorInfo": {
      "message": "<string>",
      "technicalDetails": "<string>"
    }
  },
  "createdAt": 123,
  "createdBy": "<string>",
  "endPointType": "<string>",
  "maxTurns": 123,
  "duration": 123,
  "expiresAt": "2023-11-07T05:31:56Z"
}
```

**Error Response**
```json
{
  "error": "<string>",
  "field": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}
```