Bluejay Queue Simulation Run API
The Queue Simulation Run API from Bluejay — 1 operation(s) for queue simulation run.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/bluejay:bluejay-queue-simulation-run-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: Bluejay Queue Simulation Run API
description: Bluejay API
version: 0.1.0
servers:
- url: https://api.getbluejay.ai
description: Production server
security:
- apiKeyAuth: []
tags:
- name: Queue Simulation Run
paths:
/v1/queue-simulation-run:
post:
tags:
- Queue Simulation Run
summary: Queue Simulation Run Endpoint
description: Queue a simulation run for processing.
operationId: queue_simulation_run_endpoint_v1_queue_simulation_run_post
security:
- HTTPBearer: []
parameters:
- 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.
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/SimulationRunRequestUsingBACId'
- $ref: '#/components/schemas/src__api__queue_simulation_run__SimulationRunRequest'
title: Sim Run Request
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__api__queue_simulation_run__SimulationRunResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
src__api__queue_simulation_run__SimulationRunRequest:
properties:
simulation_id:
type: string
title: Simulation Id
description: ID of the simulation to be run
prompt_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Prompt Id
description: Deprecated. Use agent_version_id. Same uuid, still works.
deprecated: true
agent_version_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Agent Version Id
description: Agent version UUID associated with this run
knowledge_base_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Knowledge Base Id
description: Knowledge base UUID associated with this run
digital_human_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Digital Human Ids
description: Digital human IDs to be used in the simulation
phone_number:
anyOf:
- type: string
- type: 'null'
title: Phone Number
description: Optional phone number to be used in this simulation run (overrides the agent phone number)
sip_uri:
anyOf:
- type: string
- type: 'null'
title: Sip Uri
description: Optional SIP URI to be used in this simulation run (overrides the agent SIP URI)
livekit_agent_name:
anyOf:
- type: string
- type: 'null'
title: Livekit Agent Name
description: Optional agent name to be used by user's livekit, an empty string will use the default agent
livekit_metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Livekit Metadata
description: metadata to be passed to the livekit room
pipecat_agent_name:
anyOf:
- type: string
- type: 'null'
title: Pipecat Agent Name
description: Pipecat agent name
pipecat_agent_configuration:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Pipecat Agent Configuration
description: Pipecat agent configuration
pipecat_room_properties:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Pipecat Room Properties
description: Pipecat room properties
eleven_labs_agent_id:
anyOf:
- type: string
- type: 'null'
title: Eleven Labs Agent Id
description: Optional ElevenLabs Convai agent_id (overrides the agent's eleven_labs_agent_id for this run)
retell_agent_id:
anyOf:
- type: string
- type: 'null'
title: Retell Agent Id
description: Optional Retell agent_id (overrides the agent's retell_agent_id for this run)
vapi_assistant_id:
anyOf:
- type: string
- type: 'null'
title: Vapi Assistant Id
description: Optional Vapi assistant_id (overrides the agent's vapi_assistant_id for this run)
runs_per_digital_human:
anyOf:
- type: integer
exclusiveMinimum: 0.0
- type: 'null'
title: Runs Per Digital Human
description: Optional per-run override for how many conversations to spawn per selected digital human. Falls back to experiments.settings.runs_per_digital_human, then to 1.
type: object
required:
- simulation_id
title: SimulationRunRequest
description: Pydantic model for simulation run request
SimulationRunRequestUsingBACId:
properties:
bluejay_as_code_id:
type: string
format: uuid
title: Bluejay As Code Id
description: Bluejay-as-Code ID of the simulation to run
prompt_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Prompt Id
description: Deprecated. Use agent_version_id. Same uuid, still works.
deprecated: true
agent_version_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Agent Version Id
description: Agent version UUID associated with this run
knowledge_base_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Knowledge Base Id
description: Knowledge base UUID associated with this run
digital_human_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Digital Human Ids
description: Digital human IDs to be used in the simulation
phone_number:
anyOf:
- type: string
- type: 'null'
title: Phone Number
description: Optional phone number to be used in this simulation run (overrides the agent phone number)
sip_uri:
anyOf:
- type: string
- type: 'null'
title: Sip Uri
description: Optional SIP URI to be used in this simulation run (overrides the agent SIP URI)
livekit_agent_name:
anyOf:
- type: string
- type: 'null'
title: Livekit Agent Name
description: Optional agent name to be used by user's livekit, an empty string will use the default agent
livekit_metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Livekit Metadata
description: metadata to be passed to the livekit room
pipecat_agent_name:
anyOf:
- type: string
- type: 'null'
title: Pipecat Agent Name
description: Pipecat agent name
pipecat_agent_configuration:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Pipecat Agent Configuration
description: Pipecat agent configuration
pipecat_room_properties:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Pipecat Room Properties
description: Pipecat room properties
eleven_labs_agent_id:
anyOf:
- type: string
- type: 'null'
title: Eleven Labs Agent Id
description: Optional ElevenLabs Convai agent_id (overrides the agent's eleven_labs_agent_id for this run)
retell_agent_id:
anyOf:
- type: string
- type: 'null'
title: Retell Agent Id
description: Optional Retell agent_id (overrides the agent's retell_agent_id for this run)
vapi_assistant_id:
anyOf:
- type: string
- type: 'null'
title: Vapi Assistant Id
description: Optional Vapi assistant_id (overrides the agent's vapi_assistant_id for this run)
runs_per_digital_human:
anyOf:
- type: integer
exclusiveMinimum: 0.0
- type: 'null'
title: Runs Per Digital Human
description: Optional per-run override for how many conversations to spawn per selected digital human.
type: object
required:
- bluejay_as_code_id
title: SimulationRunRequestUsingBACId
description: Queue a simulation run using the simulation's bluejay_as_code_id.
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
src__api__queue_simulation_run__SimulationRunResponse:
properties:
simulation_run_id:
type: string
title: Simulation Run Id
description: ID of the created simulation run
simulation_result_ids:
items:
type: string
type: array
title: Simulation Result Ids
description: IDs of the created simulation results (test results)
agent_id:
type: string
title: Agent Id
description: ID of the agent associated with the simulation run
status:
type: string
title: Status
description: Status of the response
default: success
type: object
required:
- simulation_run_id
- simulation_result_ids
- agent_id
title: SimulationRunResponse
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)