Bluejay Simulation Runs API
The Simulation Runs API from Bluejay — 2 operation(s) for simulation runs.
The Simulation Runs API from Bluejay — 2 operation(s) for simulation runs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/bluejay:bluejay-simulation-runs-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Bluejay Simulation Runs API
description: Bluejay API
version: 0.1.0
servers:
- url: https://api.getbluejay.ai
description: Production server
security:
- apiKeyAuth: []
tags:
- name: Simulation Runs
paths:
/v1/simulation-runs/{simulation_run_id}/cancel:
post:
summary: Cancel Simulation Run
description: 'Cancel an in-flight simulation run.
Cascades the cancel down to child sim_conversations:
1. Set simulation_run.status = COMPLETED (the only terminal state after
the SimulationRunStatus collapse). The fact that the user cancelled
the run is captured by child sim_conversation rows transitioning to
CANCELLED, not by a distinct sim_run status.
2. For each child sim_conversation still in PRE_RUNNING_STATUSES, call
mark_cancelled_async() — guarded so it raises if a status snuck out
of pre-running between our read and write.
3. Children that already started running (RUNNING / CONVERSATION_ENDED /
EVALUATING) are LEFT ALONE — they keep their natural terminal status
so dropped/completed calls still produce meaningful eval data.
4. Bump simulation_run.tests_cancelled by the cascade count.
The endpoint is idempotent for already-terminal sim runs (returns success=False
with a message; doesn''t try to re-cancel).'
operationId: cancel_simulation_run_v1_simulation_runs__simulation_run_id__cancel_post
security:
- HTTPBearer: []
parameters:
- name: simulation_run_id
in: path
required: true
schema:
type: integer
title: Simulation Run Id
- name: X-Organization-Id
in: header
required: false
schema:
type: string
title: X-Organization-Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CancelSimulationRunResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Simulation Runs
/v1/simulation-result/{simulation_result_id}:
delete:
tags:
- Simulation Runs
summary: Delete Simulation Result
description: Delete a single simulation result (one row in run details) by ID.
operationId: delete_simulation_result_v1_simulation_result__simulation_result_id__delete
security:
- HTTPBearer: []
parameters:
- name: simulation_result_id
in: path
required: true
schema:
type: integer
title: Simulation Result Id
- name: X-Organization-Id
in: header
required: false
schema:
type: string
title: X-Organization-Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSimulationResultResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/simulation-run/{simulation_run_id}:
delete:
tags:
- Simulation Runs
summary: Delete Simulation Run
description: Delete a single simulation run by ID. This will also delete all associated test results.
operationId: delete_simulation_run_v1_simulation_run__simulation_run_id__delete
security:
- HTTPBearer: []
parameters:
- name: simulation_run_id
in: path
required: true
schema:
type: integer
title: Simulation Run Id
- name: X-Organization-Id
in: header
required: false
schema:
type: string
title: X-Organization-Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSimulationRunResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
DeleteSimulationResultResponse:
properties:
message:
type: string
title: Message
description: Success message
deleted_simulation_result_id:
type: integer
title: Deleted Simulation Result Id
description: ID of the deleted simulation result
type: object
required:
- message
- deleted_simulation_result_id
title: DeleteSimulationResultResponse
description: Response model for the delete simulation result API (customer-facing).
DeleteSimulationRunResponse:
properties:
message:
type: string
title: Message
description: Success message
deleted_simulation_run_id:
type: integer
title: Deleted Simulation Run Id
description: ID of the deleted simulation run
type: object
required:
- message
- deleted_simulation_run_id
title: DeleteSimulationRunResponse
description: Response model for deleting a simulation run.
CancelSimulationRunResponse:
properties:
success:
type: boolean
title: Success
description: True if the sim run was marked CANCELLED
simulation_run_id:
type: integer
title: Simulation Run Id
description: The sim run that was acted upon
cancelled_test_result_ids:
items:
type: integer
type: array
title: Cancelled Test Result Ids
description: Pre-running conversations that were cascaded to CANCELLED
left_running_test_result_ids:
items:
type: integer
type: array
title: Left Running Test Result Ids
description: Children in RUNNING / CONVERSATION_ENDED / EVALUATING — left alone so they reach their own natural terminal status instead of being force-cancelled mid-call
message:
type: string
title: Message
description: Human-readable summary
type: object
required:
- success
- simulation_run_id
- message
title: CancelSimulationRunResponse
description: Response for the cancel-simulation-run endpoint.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API key required to authenticate requests.
scimToken:
type: http
scheme: bearer
description: SCIM token from Settings → Security → User provisioning (SCIM). Not an API key.
x-provenance:
method: harvested
publisher: Bluejay
source: https://api.getbluejay.ai/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)