Retrieve Simulation Results
curl --request GET \
--url https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id} \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}', 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.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-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"
"net/http"
"io"
)
func main() {
url := "https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
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.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"simulation_run": {
"id": "<string>",
"simulation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"eval_failed": 123,
"summary": "<string>",
"status": "RUNNING",
"total_tests": 123,
"tests_passed": 123,
"tests_failed": 123,
"tests_completed": 123
},
"simulation_results": [
{
"id": 123,
"digital_human_id": 123,
"result": {},
"duration": 123,
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"custom_metrics": {},
"status": "<string>",
"latency": {},
"events": [
{
"title": "<string>",
"start_offset_ms": 123,
"description": "<string>",
"end_offset_ms": 123,
"tags": [
"<string>"
],
"metadata": {}
}
],
"transcript": [
{}
],
"transcript_url": "<string>",
"audio_url": "<string>",
"evaluations": [
{
"agent_speak_percentage": 123,
"avg_agent_latency": 123,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"hallucination": true,
"hallucination_reasoning": "<string>",
"redundancy": true,
"redundancy_reasoning": "<string>",
"latency": {
"avg_agent_latency": 0,
"max_agent_latency": 0,
"p50_agent_latency": 0,
"p90_agent_latency": 0,
"p95_agent_latency": 0,
"p99_agent_latency": 0
},
"filler_ignored_latency": {
"avg_filler_ignored_latency": 0,
"p50_filler_ignored_latency": 0,
"p90_filler_ignored_latency": 0,
"p95_filler_ignored_latency": 0,
"p99_filler_ignored_latency": 0
},
"num_turns": 123,
"call_summary": "<string>",
"custom_evals": [
"<unknown>"
],
"custom_evals_success_rate": 123,
"goal_success": true,
"goal_reasoning": "<string>",
"pronunciation_score": 123,
"pronunciation_reasoning": "<string>",
"sentiment_label": "<string>",
"sentiment_score": 123,
"sentiment_scores": {},
"custom_metrics": [
{
"name": "<string>",
"description": "<string>",
"response_type": "<string>",
"response_value": "<string>",
"reasoning": "<string>",
"min_value": 123,
"max_value": 123,
"category": "<string>",
"tags": [
"<string>"
],
"scoring_guidance": "<string>",
"enum_options": [
"<string>"
],
"human_edited": true,
"human_response_value": "<string>",
"human_reasoning": "<string>",
"override_reason_code": "<string>",
"override_notes": "<string>",
"last_edited_by": "<string>",
"last_edited_at": "2023-11-07T05:31:56Z"
}
],
"human_edited": true,
"human_goal_success": true,
"human_goal_reasoning": "<string>",
"human_hallucination": true,
"human_hallucination_reasoning": "<string>",
"human_redundancy": true,
"human_redundancy_reasoning": "<string>",
"human_pronunciation_score": 123,
"human_pronunciation_reasoning": "<string>",
"override_goal_reason_code": "<string>",
"override_goal_notes": "<string>",
"override_hallucination_reason_code": "<string>",
"override_hallucination_notes": "<string>",
"override_redundancy_reason_code": "<string>",
"override_redundancy_notes": "<string>",
"override_pronunciation_reason_code": "<string>",
"override_pronunciation_notes": "<string>",
"last_edited_by": "<string>",
"last_edited_at": "2023-11-07T05:31:56Z",
"predicted_age": 123,
"customer_gender": "<string>",
"gender_confidence": 123,
"detected_language": "<string>",
"language_confidence": 123,
"agent_audio_clarity": 123,
"user_audio_clarity": 123
}
],
"tool_calls": [
{
"name": "<string>",
"expected": [
{
"parameters": {},
"output": "<unknown>"
}
],
"actual": [
{
"parameters": {},
"output": "<unknown>",
"start_offset_ms": 123
}
]
}
],
"trace_ids": [
"<string>"
],
"metrics": [
{
"metric_id": "<string>",
"name": "<string>",
"type": "<string>",
"value": "<unknown>",
"not_applicable": false,
"reasoning": "<string>"
}
]
}
],
"status": "200"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Simulation Runs
Retrieve Simulation Results
Retrieve one page of a simulation run’s results. Default 100 conversations, max 100.
GET
/
v1
/
retrieve-simulation-results
/
{simulation_run_id}
Retrieve Simulation Results
curl --request GET \
--url https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id} \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}', 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.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-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"
"net/http"
"io"
)
func main() {
url := "https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
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.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"simulation_run": {
"id": "<string>",
"simulation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"eval_failed": 123,
"summary": "<string>",
"status": "RUNNING",
"total_tests": 123,
"tests_passed": 123,
"tests_failed": 123,
"tests_completed": 123
},
"simulation_results": [
{
"id": 123,
"digital_human_id": 123,
"result": {},
"duration": 123,
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"custom_metrics": {},
"status": "<string>",
"latency": {},
"events": [
{
"title": "<string>",
"start_offset_ms": 123,
"description": "<string>",
"end_offset_ms": 123,
"tags": [
"<string>"
],
"metadata": {}
}
],
"transcript": [
{}
],
"transcript_url": "<string>",
"audio_url": "<string>",
"evaluations": [
{
"agent_speak_percentage": 123,
"avg_agent_latency": 123,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"hallucination": true,
"hallucination_reasoning": "<string>",
"redundancy": true,
"redundancy_reasoning": "<string>",
"latency": {
"avg_agent_latency": 0,
"max_agent_latency": 0,
"p50_agent_latency": 0,
"p90_agent_latency": 0,
"p95_agent_latency": 0,
"p99_agent_latency": 0
},
"filler_ignored_latency": {
"avg_filler_ignored_latency": 0,
"p50_filler_ignored_latency": 0,
"p90_filler_ignored_latency": 0,
"p95_filler_ignored_latency": 0,
"p99_filler_ignored_latency": 0
},
"num_turns": 123,
"call_summary": "<string>",
"custom_evals": [
"<unknown>"
],
"custom_evals_success_rate": 123,
"goal_success": true,
"goal_reasoning": "<string>",
"pronunciation_score": 123,
"pronunciation_reasoning": "<string>",
"sentiment_label": "<string>",
"sentiment_score": 123,
"sentiment_scores": {},
"custom_metrics": [
{
"name": "<string>",
"description": "<string>",
"response_type": "<string>",
"response_value": "<string>",
"reasoning": "<string>",
"min_value": 123,
"max_value": 123,
"category": "<string>",
"tags": [
"<string>"
],
"scoring_guidance": "<string>",
"enum_options": [
"<string>"
],
"human_edited": true,
"human_response_value": "<string>",
"human_reasoning": "<string>",
"override_reason_code": "<string>",
"override_notes": "<string>",
"last_edited_by": "<string>",
"last_edited_at": "2023-11-07T05:31:56Z"
}
],
"human_edited": true,
"human_goal_success": true,
"human_goal_reasoning": "<string>",
"human_hallucination": true,
"human_hallucination_reasoning": "<string>",
"human_redundancy": true,
"human_redundancy_reasoning": "<string>",
"human_pronunciation_score": 123,
"human_pronunciation_reasoning": "<string>",
"override_goal_reason_code": "<string>",
"override_goal_notes": "<string>",
"override_hallucination_reason_code": "<string>",
"override_hallucination_notes": "<string>",
"override_redundancy_reason_code": "<string>",
"override_redundancy_notes": "<string>",
"override_pronunciation_reason_code": "<string>",
"override_pronunciation_notes": "<string>",
"last_edited_by": "<string>",
"last_edited_at": "2023-11-07T05:31:56Z",
"predicted_age": 123,
"customer_gender": "<string>",
"gender_confidence": 123,
"detected_language": "<string>",
"language_confidence": 123,
"agent_audio_clarity": 123,
"user_audio_clarity": 123
}
],
"tool_calls": [
{
"name": "<string>",
"expected": [
{
"parameters": {},
"output": "<unknown>"
}
],
"actual": [
{
"parameters": {},
"output": "<unknown>",
"start_offset_ms": 123
}
]
}
],
"trace_ids": [
"<string>"
],
"metrics": [
{
"metric_id": "<string>",
"name": "<string>",
"type": "<string>",
"value": "<unknown>",
"not_applicable": false,
"reasoning": "<string>"
}
]
}
],
"status": "200"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Integration Prompt for AI Agents
# Bluejay — Testing & Monitoring Platform for Conversational AI Agents
You are a senior backend engineer integrating the Bluejay API. Think step-by-step: first understand the endpoint, then plan the integration, then implement with minimal changes.
## Retrieve Simulation Results — GET /v1/retrieve-simulation-results/{simulation_run_id}
> **What this endpoint does:** Returns the simulation run summary plus one page of conversations. Default `limit` is 100. Max `limit` is 100. Use `offset` to walk further pages. Existing callers that omit these params still work, but runs with more than 100 conversations only get the first page.
**Endpoint:** GET `https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}`
**Auth:** `X-API-Key` header
### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| simulation_run_id | string | |
| X-API-Key | string | API key required to authenticate requests. |
### Optional Parameters
| Name | Type | Description |
|------|------|-------------|
| limit | integer | How many conversations to return. Default 100. Min 1. Max 100. Values outside that range return 422. |
| offset | integer | How many conversations to skip, oldest first. Default 0. |
### Example
**Page through every conversation:**
```python
import requests
def retrieve_simulation_results(simulation_run_id: str, api_key: str) -> dict:
url = f"https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}"
headers = {"X-API-Key": api_key}
limit = 100
offset = 0
pages = []
while True:
response = requests.get(url, headers=headers, params={"limit": limit, "offset": offset})
response.raise_for_status()
page = response.json()
pages.append(page)
results = page.get("simulation_results") or []
if len(results) < limit:
break
offset += limit
run = pages[0]["simulation_run"]
all_results = [r for p in pages for r in (p.get("simulation_results") or [])]
return {"simulation_run": run, "simulation_results": all_results, "status": "200"}
```
Each conversation includes `transcript` (turns from the database) when stored inline. `transcript_url` is only set when the transcript is not in the database. Prefer `transcript`, then fall back to downloading `transcript_url`.
`simulation_run` is the full run (status, `total_tests`, `tests_passed`). It is not paged. Stop paging when a page has fewer than `limit` conversations. There is no `has_more` field.
### Constraints
- Minimal changes. Only add or change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 422: Validation Error (`limit` not in 1–100, or `offset` < 0).
### Integration Checklist
Before writing code, verify:
1. Which module/service owns this API domain in the codebase?
2. What HTTP client and error-handling patterns does the project use?
3. Are there existing types/interfaces to extend?
Then implement the integration, export it, and confirm it compiles/passes lint.
simulation_run_id.
limit defaults to 100 and cannot exceed 100. offset skips that many conversations, oldest first. Omitting both is the same as limit=100&offset=0. A run with more than 100 conversations needs further pages (offset=100, offset=200, …) until a page is shorter than limit.
simulation_run is always the whole run. Use total_tests for the run size, not the length of the current simulation_results array.
Each conversation includes evaluations, metrics, and tool calls. Transcripts come back as transcript when they are stored in the database. transcript_url is only present when they are not.Path Parameters
Query Parameters
How many results to return.
Required range:
1 <= x <= 100How many results to skip.
Required range:
x >= 0Keep results linked to any of these simulation issue IDs
Response
Successful Response