Docs

Docs

/

API Reference

/

API Reference: Real-Time Status

API Reference: Real-Time Status

The Real-Time Status module provides a sub-millisecond heartbeat of your infrastructure. Powered by our high-availability WebSocket cluster, this endpoint ensures you have total observability over your active pipeline states.

Endpoint

GET /v1/status/live

Request Parameters

Parameter

Type

Required

Description

workspace_id

String

Yes

Your unique studio identifier.

verbose

Boolean

No

Set to true for granular per-node execution logs.

Response Schema

JSON

{
  "status": "healthy",
  "latency": "24ms",
  "active_workflows": 12,
  "last_deploy": "2026-03-09T04:49Z"
}
{
  "status": "healthy",
  "latency": "24ms",
  "active_workflows": 12,
  "last_deploy": "2026-03-09T04:49Z"
}
{
  "status": "healthy",
  "latency": "24ms",
  "active_workflows": 12,
  "last_deploy": "2026-03-09T04:49Z"
}

Implementation Note

This endpoint is designed for high-frequency consumption. However, if you are building a custom monitoring dashboard, we recommend implementing local memoization (caching the result for ~500ms) to avoid saturating your client-side bandwidth during spikes in workflow activity.

Create a free website with Framer, the website builder loved by startups, designers and agencies.