Rendering

Render a widget payload to HTML

post

/api/v1/render/widget

Renders a widget payload (as emitted by agent/MCP tools or stored on reports) into a self-contained themed HTML fragment with inline styles — the same session-less renderer used across the platform's export surfaces. Suited to embedding: notebook rich display, emails, static pages. Body: widget (type plus kind-specific fields), theme (light | dark). 422 when the kind needs a live session or the payload is a bare pointer.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Body

themestring · enumOptional

Render theme (default light)

Possible values:

Responses

200

Successful response

application/json

dataany of · nullableRequired

Payload not declared in this repo

stringOptional

or

numberOptional

or

booleanOptional

or

or

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

post/api/v1/render/widget

POST /api/v1/render/widget HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "widget": {
    "type": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "theme": "light"
}

{
  "data": "text"
}