Skip to main content
DELETE
/
v1
/
simulation
/
{simulation_id}
Delete Simulation
curl --request DELETE \
  --url https://api.getbluejay.ai/v1/simulation/{simulation_id} \
  --header 'X-API-Key: <x-api-key>'
{
  "message": "<string>",
  "deleted_simulation_id": 123
}
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.

## Delete Simulation — DELETE /v1/simulation/{simulation_id}

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

**Endpoint:** DELETE `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
**DELETE request:**
```python
import requests

def delete_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.delete(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.
Given the simulation ID, this endpoint permanently deletes the simulation.

Headers

​
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

​
simulation_id
integer
required

Response

Successful Response

Response model for deleting a simulation

​
message
string
required

Success message

​
deleted_simulation_id
integer
required

ID of the deleted simulation