Quickstart

Make your first request to the Diagram Rendering API.

1. Get access

Subscribe to the listing for your endpoint. Your marketplace provides credentials and billing.

RRapidAPI
Complete APIGet access
aApyHub
Diagrams, equations & codeGet access

2. Set your credentials

Set RAPIDAPI_KEY or APY_TOKEN on your server. Python examples require httpx; Node.js examples use built-in fetch.

python -m pip install httpx

export RAPIDAPI_KEY="YOUR_RAPIDAPI_KEY"
# or
export APY_TOKEN="YOUR_APYHUB_TOKEN"

3. Send a request

Start with the sample values, then change the input.

import os
import httpx

base_url = "https://diagram-math-code-render-api.p.rapidapi.com"
headers = {
    "X-RapidAPI-Key": os.environ["RAPIDAPI_KEY"],
    "X-RapidAPI-Host": "diagram-math-code-render-api.p.rapidapi.com",
}
payload = {
    "engine": "mermaid",
    "source": "flowchart LR\n  A[Your idea] --> B[An API call]\n  B --> C[A finished diagram]",
    "format": "png",
    "width": 900,
    "scale": 1,
    "theme": "neutral",
}
response = httpx.post(
    base_url + "/v1/render/diagram",
    headers=headers, json=payload, timeout=120
)
response.raise_for_status()
with open("result.png", "wb") as output:
    output.write(response.content)

4. Check the result

Check the status and Content-Type before saving the returned file.

The demo supports diagrams, math and code with source up to 8 KiB and bounded output formats. Remote assets and external data are unavailable in demos. Syntax errors identify the input to correct.

Task tutorial

Errors and retries

  • 401 / 403: check your credentials, subscription and feature access.
  • 422: correct the input before retrying. Application errors include a detail object with a code and message.
  • 429: check your rate limit or plan allowance.
  • 502 / 503 / 504: use bounded retries with backoff and honor Retry-After. Retries may consume allowance.

Marketplace errors may use a different format. Keep the status and request identifier for diagnostics; avoid logging API keys or customer files.