ChartQuery

Diagram View

GET
/v1/diagram/view/{id}

View a previously saved diagram as an HTML page. Public, no API key required. Iframe-embeddable with inline SVG rendering.

Parámetros de ruta

id*string

The diagram ID returned in the X-Diagram-View-URL header when saving a diagram. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Parámetros de consulta

share?boolean

Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.

Defaultfalse
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Cuerpo de la respuesta

Successful response

response?stringapplication/json
Example Request
curl -X GET 'https://api.chartquery.com/v1/diagram/view/string'
Example Response
"<!DOCTYPE html><html><!-- rendered diagram image embedded in a responsive page --></html>"