Skip to main content
GET
Discover SDK WebSocket connection

Authorizations

X-API-Key
string
header
required

API key for authentication.

Path Parameters

simulation_id
string
required

The simulation execution ID.

Response

Current connection state. Cache-Control is no-store.

status
enum<string>
required
Available options:
PENDING,
READY,
CONNECTED,
CLOSED,
FAILED,
CANCELLED,
EXPIRED
simulation_id
string
required
attempt_id
string | null

Null until an attempt starts.

wss_url
string | null

Null except when status is READY.

token
string | null

Null except when status is READY.

expires_at
integer | null

Unix epoch seconds; null except when status is READY.