Skip to main content
GET
/
v1
/
get-all-simulations
Get All Simulations
curl --request GET \
  --url https://api.getbluejay.ai/v1/get-all-simulations \
  --header 'X-API-Key: <x-api-key>'
{
  "simulations": [
    {
      "id": 123,
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "agent_id": 123,
      "settings": {}
    }
  ]
}
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 All Simulations — GET /v1/get-all-simulations

> **What this endpoint does:** Get all simulations for a user.

**Endpoint:** GET `https://api.getbluejay.ai/v1/get-all-simulations`
**Auth:** `X-API-Key` header

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

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

def get_all_simulations(api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/get-all-simulations"
    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 simulations across all agents.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Response

Successful Response

​
simulations
SimulationRes · object[]

List of simulations