Перейти до вмісту

ШІ-агенти

Якщо інтеграцію за вас пише ШІ-агент, спершу дайте йому https://occultapi.com/AGENTS.md. Це короткий бриф про чотири речі, у яких агенти з цим API помиляються найчастіше.

Дайте агентові це

Вставте це в агента, перш ніж він почне роботу. Це звичайний markdown без автентифікації й з відкритим CORS — агент може завантажити його сам.

Read https://occultapi.com/AGENTS.md before writing any code against Occult API.
Use the OpenAPI spec at https://occultapi.com/openapi.json for exact field names.

Що там сказано і чому

Чотири правила — і кожне тому, що агенти справді роблять тут саме цю помилку. Це не загальний посібник зі стилю.

  • Об’єднуйте розрахунки через keys, а не в циклі. Кілька розрахунків в одному запиті коштують один кредит, а ті самі розрахунки окремими викликами — по кредиту за кожен. Агент, що дбає про читабельність коду, напише цикл, і заплатить за це ваш баланс.
  • Не повторюйте запит після 402. Цей код означає, що ключ дійсний, а баланс порожній. Агент, який вважає це тимчасовим збоєм, повторюватиме без кінця, а той, що вважає це помилкою автентифікації, перевипустить цілком робочий ключ. Повторювати варто лише 429 і 5xx.
  • Ключ — лише для сервера. Пишемо це прямо, бо «викликати з клієнта» — найпростіший шлях, і він виставляє ваш ключ на загальний огляд.
  • Читайте специфікацію, не вгадуйте назви полів. Документ OpenAPI містить кожне поле, його допустимі значення й приклад для кожного ендпоінта, здебільшого перевірений на робочому сервері. Один запит до специфікації кращий за три помилки 400.

Якщо агент підтримує MCP, краще використовуйте його

Наш MCP-сервер відкриває всі 299 ендпоінтів через п’ять інструментів, а пошук і читання схем кредитів не коштують — платним є лише сам розрахунок. Агент може безкоштовно дослідити весь API й витрачати кредити лише тоді, коли щось розраховує. Це і дешевше, і надійніше, ніж змушувати його вгадувати за документацією.

Спершу прочитайте самі

Перш ніж віддавати /AGENTS.md агентові, витратьте на нього дві хвилини самі. Адже саме ви дізнаєтеся, якщо порада виявиться хибною.

Далі