AstroWay/api v2.130.2 · blog
усі системи в нормі

Документація, зроблена для AI-агентів, а не тільки для людей

Класична документація зроблена під людські очі: гарний HTML, підсвітка коду, навігація. Але половина трафіку до docs тепер - агенти й асистенти, яким потрібен plain-text, а не рендер. Розбираємо, що ми додали: .md-двійник кожної сторінки, llms.txt, машиночитані специфікації, dropdown «відкрити в ChatGPT / Claude» і inline try-it.

Класична документація зроблена під людину: рендерений HTML, підсвітка синтаксису, сайдбар, пошук. Але дедалі частіше по docs ходить не людина, а агент - Claude, Cursor, ChatGPT - якому весь цей рендер тільки заважає. Йому потрібен чистий текст і машиночитаний контракт.

Ми зробили документацію придатною для обох. Ось що під капотом.

.md-двійник кожної сторінки

Section titled “.md-двійник кожної сторінки”

Кожна сторінка контент-документації має сирий Markdown-двійник за тим самим шляхом із суфіксом .md. Відкрив /agent-setup - є і /agent-setup.md, той самий текст без HTML-обгортки, MDX-імпорти зрізані, віддається як text/markdown.

Це живить дві дії у меню сторінки: Copy as Markdown (кладе чистий текст у буфер, щоб вставити в чат із моделлю) і View as Markdown (відкриває .md-версію напряму). Агенту не треба парсити DOM - він забирає готовий текст.

Section titled “Dropdown дій угорі сторінки”

У правому верхньому куті кожної сторінки - меню дій, зроблене саме під агентний воркфлоу:

  • Copy as Markdown - чистий текст сторінки в буфер
  • View as Markdown - відкрити .md-двійник
  • Open in ChatGPT - передати сторінку в ChatGPT одним кліком
  • Open in Claude - те саме для Claude
  • Connect MCP - перехід до налаштування MCP-сервера

Замість «скопіюй URL, відкрий чат, попроси зайти на сторінку» - одна дія.

За стандартом llmstxt.org ми віддаємо два файли:

  • /llms.txt - індекс усіх сторінок документації, згрупований у секції (API Reference, Use Cases, Examples, Products). Карта для агента, з чого почати.
  • /llms-full.txt - уся документація одним plain-text файлом. Для offline-індексації у векторній базі або одноразового вставлення в контекст моделі.

Якщо будуєш RAG поверх нашого API, llms-full.txt - це готовий корпус, не треба краулити сайт.

Машиночитані специфікації

Section titled “Машиночитані специфікації”

Контракт віддається кількома форматами під різні інструменти:

  • /v1/openapi.json - канонічна OpenAPI 3.1-специфікація з прикладами і code-samples. Для кодогенерації клієнтів і будь-якого OpenAPI-тулінгу.
  • Swagger-аліаси - /v1/swagger.json, /v1/v3/api-docs та інші 301-редіректять на канон, щоб інструменти, які шукають звичні шляхи, не спотикались.
  • Postman-колекція - /postman/astroway-api.json для імпорту в Postman одним кліком.

/agent-setup під конкретні клієнти

Section titled “/agent-setup під конкретні клієнти”

Сторінка /agent-setup/ - не один загальний гайд, а окремі інструкції під сім клієнтів: Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Cline, Codex. Кожна дає точний конфіг і curl-приклад tools/list, щоб перевірити підключення до того, як писати код.

На сторінках API-довідника кожна операція має вбудований віджет try-it: вставляєш sandbox-ключ, редагуєш тіло запиту, тиснеш «Send» - і бачиш реальну відповідь, не виходячи з docs. Метод, шлях і приклад тіла беруться з уже згенерованого curl-сниппета, тому віджет не робить зайвих запитів по openapi.json.

Проста теза: якщо твій продукт - API, документація має бути придатна не тільки для читання очима, а й для споживання агентом. Половина інтеграцій сьогодні починається з того, що розробник кидає посилання на docs у Claude чи Cursor і просить «підключи це». Ми зробили так, щоб на тому кінці був чистий текст і машинний контракт, а не HTML, який треба розпарсити.

Спробуй сам: відкрий будь-яку сторінку docs, натисни меню дій угорі праворуч - і побачиш «Open in Claude».

AstroWay team

Інженерна команда AstroWay API. Ми загортаємо Swiss Ephemeris у чистий REST і пишемо про нудні деталі, які насправді важливі.

// побудуй на цьому

Той самий Swiss Ephemeris, що й у Solar Fire — у 4 рядках коду.

Безкоштовний ключ без картки. 5 000 викликів на місяць до першої оплати.

Більше з блогу усі дописи →

Engineering 2026-07-15

Три офіційні SDK: TypeScript, Python, PHP замість сирого curl

Сирий HTTP працює, але типізований клієнт економить години: автодоповнення шляхів, типи запиту й відповіді, вбудований retry на 408/409/429/5xx і Stainless-style ієрархія помилок. Розбираємо три офіційні SDK - @astroway/sdk (npm), astroway (PyPI), astroway/sdk (Packagist) - і чим вони згенеровані з одного OpenAPI-контракту.

Engineering 2026-06-05

X-Cache header: видимий cache-status для оптимізації клієнтських інтеграцій

Кожна response API тепер несе X-Cache: MISS | HIT | BYPASS — клієнт відразу бачить чи запит обчислений з нуля, чи витягнутий з кешу. Це відкриває cache hit % колонку в /dashboard/usage та дозволяє оптимізувати інтеграцію без guesswork.

Ephemeris 2026-06-02

Eclipse path, cosmogram і Vedic-карти: pure-SVG візуалізатори без headless-Chrome

Шість ендпоінтів сімейства /v1/render/* для специфічних візуалізацій — три Vedic-картки (North/South/East Indian), Hamburg-School 90° cosmogram, equirectangular eclipse-path та stereographic star-map. Усі рендери — чистий SVG-стрінг, без браузерного worker-а.