Diagrams

Check a diagram without saving (public)

Checks a DSP scene or Mermaid text without saving it, and needs no key. A valid scene is also laid out and drawn, so warnings include what drawing notices. Counts against the per-IP rate limit, and the ceiling shared by callers without a key, even when a key is sent. An API key, or the site's signed-in session, raises the drawing budget from 5 s to 20 s.

post/v1/diagrams/validate

Request

  • Base URL: https://api.zindex.ai
  • URL: https://api.zindex.ai/v1/diagrams/validate
  • Auth: none required

Request body

OR

Response

{ ok, errors, warnings }, each entry with a code, the element when there is one, and a one-line fix; at most 10 in each list. A scene with errors answers 200 with ok: false. A valid scene is also laid out and drawn, so warnings include what drawing notices.

Changes

No recorded changes to this operation across all 1 revision of this API.