Skip to main content
GET
Get Simulation
Integration Prompt for AI Agents
This endpoint allows you to retrieve a specific simulation by ID.

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

simulation_id
integer
required

Response

Successful Response

agent_id
integer
required
name
string
required
type
enum<string>
required
Available options:
max_concurrent,
parallel
id
integer | null
bluejay_as_code_id
string<uuid> | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
updated_by
string<uuid> | null
created_by
string<uuid> | null
settings
Settings · object | null
max_concurrent
integer | null
max_turns
integer | null
ringing_timeout
integer | null
inactivity_timeout_seconds
integer | null
tags
string[] | null
description
string | null
pinned
boolean | null
always_on
boolean | null