Перейти до контенту

rombik API

HTTP API для блок-схем і структограм зі скриптів. Автентифікація — заголовок X-API-Key.

Повна довідка API

Усі ендпоінти, параметри, приклади коду різними мовами й «спробувати» — інтерактивно, окремою сторінкою.

Відкрити довідку →

Що вміє /render

Одна ручка, але налаштувань більше, ніж здається. Усе нижче — параметри того самого виклику.

10 мов
python, cpp, c, java, csharp, pascal, javascript, typescript, php, go — плюс rombik: власне дерево схеми (astJSON) для будь-якої іншої мови.
14 форматів
docx, visio, drawio, typst, excalidraw, svg, png, jpeg, webp, gif, gif_anim, pdf, html, json — docx і visio виходять рідними фігурами, які редагуються далі.
Картинки й веб-сторінка
jpeg — растр на білому тлі; webp — без втрат і легший за png; gif — статичний, 256 кольорів; gif_anim — схема малюється блок за блоком, у циклі; html — схема й код із номерами рядків однією сторінкою. З json: true растр приходить у base64, як png, а html — текстом, як svg.
Два види діаграм
mode: "flow" — блок-схема за стандартом; mode: "nsd" — структограма Насі-Шнайдермана.
Джерело — код або посилання
замість code передай url: raw.githubusercontent.com, gist, gitlab, bitbucket, codeberg (посилання виду github.com/…/blob/… нормалізується саме).
Пакет до 100 джерел
/render/batch збирає багатосторінковий PDF або zip; у відповіді заголовки X-Rombik-Rendered і X-Rombik-Failed.
Тонке налаштування
об’єкт options: локаль, свої слова на гілках «так/ні», термінатори, нумерація рисунків, масштаб, шрифт. Розбиття високих схем конекторами А/Б — split.
Постер
format: "poster" — код і схема поруч однією картинкою для соцмереж.

Інтеграції та інструменти

Для AI-агентів

Готовий скіл у відкритому форматі Agent Skills — Claude Code, Codex, GitHub Copilot, Cursor, Gemini CLI та інші.

Встановити в агента
sh
npx skills add OlexiyOdarchuk/rombik-skill
Скіл на GitHub →

CLI rombik

Працюй з API прямо з терміналу — render, batch, тариф, оплата.

macOS / Linux
sh
curl -fsSL https://rombik.app/install.sh | sh
Команди для Windows
Windows (PowerShell)
ps1
irm https://rombik.app/install.ps1 | iex
Windows (CMD)
cmd
curl -fsSL https://rombik.app/install.cmd -o "%TEMP%\rombik-install.cmd" && "%TEMP%\rombik-install.cmd"
Усі команди
sh
rombik auth                                   # вхід через браузер (або: rombik auth rk_…)
rombik render main.py -f pdf -o chart.pdf
rombik render app.ts -f drawio -o app.drawio
rombik render main.go --structogram -f svg    # структограма Насі-Шнайдермана
cat prog.cpp | rombik render - --lang cpp -f png -o prog.png
rombik render --url https://raw.githubusercontent.com/…/main.py -f svg
rombik render main.py -f pdf --link           # ще й тимчасове посилання на результат
rombik batch src/*.py -f pdf -o project.pdf   # багато джерел за раз
rombik me                                     # тариф і ліміт місяця
rombik products                               # каталог тарифів
rombik topup 3                                # лінк на оплату тарифу з id 3
rombik mcp                                    # MCP-сервер по stdio
rombik version --json                         # {version, latest, updateAvailable}
rombik update                                 # оновити до найновішої
rombik logout                                 # прибрати збережений ключ

Ключ ніколи не передається аргументом — лише через змінну ROMBIK_API_KEY або конфіг після «rombik auth». Базова адреса API — ROMBIK_API_URL. Повний перелік прапорців: «rombik render -h».

Встановити вручну

Команда встановлення вгорі визначає систему сама. Тут — прямі посилання на бінарники.

MCP-сервер

Агент дістає інструменти render_flowchart, balance, products, topup_link. Два способи: remote-сервер — без жодної установки, або локально через CLI (stdio).

Remote — без установки
url
https://rombik.app/mcp

Встав адресу в MCP-клієнт (конектори ChatGPT, Claude, Cursor…) — вхід відкриється сам у браузері (OAuth), ключі вводити не треба. Доступ відкликається в акаунті.

Claude Code
sh
claude mcp add --transport http rombik https://rombik.app/mcp
Клієнти з JSON-конфігом
json
{
  "mcpServers": {
    "rombik": { "url": "https://rombik.app/mcp" }
  }
}
Локально через CLI (stdio)

Спершу постав CLI й виконай «rombik auth», тоді додай конфіг у свій клієнт. Ключ живе у файлі конфігурації і не потрапляє в контекст моделі.

Claude Code
sh
claude mcp add rombik -- rombik mcp
Cursor / Windsurf (JSON)
json
{
  "mcpServers": {
    "rombik": { "command": "rombik", "args": ["mcp"] }
  }
}

Тимчасові посилання на результат

Коли показати файл нема де — чат-бот, вебхук, лист — віддай посилання замість байтів. Надішли результат рендеру на /r і отримай публічну адресу, яка живе годину: картинки й PDF відкриються прямо в браузері, решта піде на завантаження. У CLI те саме робить прапорець --link, у remote MCP — те саме сховище.

Вхід через rombik

Твій застосунок може попросити користувача увійти акаунтом rombik. Користувач бачить сторінку згоди з назвою застосунку, натискає «Дозволити» — і ти отримуєш ключ до API, яким рендериш схеми за його тарифом. Це звичайний OAuth 2.0 (authorization code + PKCE) з надбудовою OpenID Connect, тож підходить будь-яка стандартна бібліотека.

  1. 1 Зареєструвати застосунок

    Один виклик /oauth/register з назвою і адресами повернення — у відповідь client_id. Реєстрація відкрита, схвалення ні в кого просити не треба. Серверний застосунок отримує ще й секрет; мобільному, SPA чи CLI секрет не потрібен — їх захищає PKCE.

  2. 2 Отримати згоду користувача

    Відкрий йому сторінку /oauth/authorize. Він бачить назву твого застосунку, натискає «Дозволити» — і повертається на твою адресу з одноразовим кодом. Код живе 10 хвилин.

  3. 3 Обміняти код на токен

    Виклик /oauth/token із кодом і перевіркою PKCE віддає access_token. Це звичайний ключ API rombik — далі жодної окремої логіки, працюють усі ендпоінти. Область openid додає в ту саму відповідь id_token з ідентичністю.

  4. 4 Працювати від імені користувача

    Хто це — /oauth/userinfo, ключі для перевірки підпису id_token — /oauth/jwks. Далі звичайний /render — за тарифом користувача.

Бібліотеки з підтримкою discovery налаштуються самі — дай їм адреси метаданих: https://rombik.app/.well-known/oauth-authorization-server https://rombik.app/.well-known/openid-configuration

Що важливо знати
  • Рендер іде за тарифом користувача, який дав згоду (потрібен Pro), а не за твоїм.
  • Токен не має терміну дії. Користувач будь-коли відкликає доступ у своєму акаунті — ключ зникає, виклики починають повертати 401.
  • PKCE (S256) обов’язковий для клієнтів без секрета; метод plain не приймається.
  • Замість реєстрації client_id може бути https-адресою документа з метаданими застосунку — такий клієнт завжди вважається публічним.
  • Назва застосунку зі сторінки згоди — це те, що користувач побачить у списку доступів свого акаунта.
Параметри, поля відповідей і «спробувати» — у довідці API →

Рідний формат rombik / rombik native format

Для непідтримуваних мов — постав lang:"rombik" і передай astJSON (потребує Pro).

Повна специфікація (види вузлів, поля) — /api/v1/rombik-format.md.

переглянути специфікацію →

А скільки це коштує?

Без окремих «API-тарифів»: API, CLI і MCP входять у тариф Pro разом із редактором — той самий місячний ліміт експортів, що й на сайті. Оформити — на сторінці тарифів або через topup_link у MCP.

Тарифи →

Готовий почати?