Skip to main content
GET
/
v1
/
get-simulation-runs
/
{simulation_id}
Get Simulation Runs
curl --request GET \
  --url https://api.getbluejay.ai/v1/get-simulation-runs/{simulation_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "simulation_runs": [
    {
      "id": 123,
      "experiment_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "status": "INITIALIZING",
      "summary": "<string>",
      "tests_passed": 123,
      "tests_failed": 123,
      "total_tests": 123,
      "tests_completed": 123,
      "tests_incompleted": 123,
      "curr_step_id": 123,
      "phone_number": "<string>"
    }
  ]
}
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.

## Get Simulation Runs — GET /v1/get-simulation-runs/{simulation_id}

> **What this endpoint does:** Get all simulation runs for a specific simulation.

**Endpoint:** GET `https://api.getbluejay.ai/v1/get-simulation-runs/{simulation_id}`
**Auth:** `X-API-Key` header

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| simulation_id | string |  |
| X-API-Key | string | API key required to authenticate requests. |

### Example
**Simple GET:**
```python
import requests

def get_simulation_runs(simulation_id: str, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/get-simulation-runs/{simulation_id}"
    headers = {"X-API-Key": api_key}
    response = requests.get(url, headers=headers)
    response.raise_for_status()
    return response.json()
```

### Constraints
- Minimal changes — only add/change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 422: Validation Error.

### 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.
This endpoint allows you to retrieve all runs for a specific simulation.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

​
simulation_id
string
required

Response

Successful Response

​
simulation_runs
SimulationRunRes · object[]

List of simulation runs