Get Simulation

Get a specific simulation by ID.

GET /v1/simulation/{simulation_id}

Get Simulation

cURL

curl --request GET \
  --url https://api.getbluejay.ai/v1/simulation/{simulation_id} \
  --header 'X-API-Key: <x-api-key>'

200

{
  "agent_id": 123,
  "name": "<string>",
  "type": "sequential",
  "id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "settings": {},
  "max_concurrent": 123,
  "max_turns": 123,
  "ringing_timeout": 123,
  "tags": [
    "<string>"
  ],
  "description": "<string>",
  "pinned": true,
  "always_on": true
}

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 — GET /v1/simulation/{simulation_id}

> **What this endpoint does:** Get a specific simulation by ID.

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

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

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

def get_simulation(simulation_id: int, api_key: str) -> dict:
    url = f"https://api.getbluejay.ai/v1/simulation/{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 a specific simulation by ID.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Path Parameters

simulation_id · integer · required

Response

200

application/json

Successful Response

agent_id · integer · required

name · string · required

type · enum<string> · required

Available options: sequential, parallel, max_concurrent

id · integer | null

created_at · string<date-time> | null

settings · Settings · object

max_concurrent · integer | null

max_turns · integer | null

ringing_timeout · integer | null

tags · string[] | null

description · string | null

pinned · boolean | null

always_on · boolean | null