Response Envelope

Notes:

Public API v1 is currently in feature preview and as such documentation for this feature is still work in progress

All successful Public API v1 responses are wrapped in a standard envelope.

Envelope shape

{
  "data": {},
  "meta": {
    "apiVersion": "1.0",
    "requestId": "00-6b2f90b3a92445f792a2b2a6b4d8e6d0-0a8a7d9b9d8c4e2f-00",
    "correlationId": "3f3cb61b8f5342b4b4f0a3e2e1d0d5b1",
    "workspaceIdentifier": "demo",
    "timestamp": "2026-02-03T05:16:02.000Z",
    "rateLimit": {
      "limit": 100,
      "remaining": 95,
      "resetsAt": "2026-02-03T05:20:00.000Z"
    }
  }
}

Fields

• data contains the response payload for the endpoint.
• meta.apiVersion identifies the API version used to generate the response.
• meta.requestId is the unique request identifier.
• meta.correlationId is the correlation identifier for tracing.
• meta.workspaceIdentifier is the workspace identifier for the request context.
• meta.timestamp is the UTC timestamp when the response was generated.
• meta.rateLimit contains rate limit information when available.