Перший запит за пʼять хвилин
Як отримати API-ключ BDO UA Translate, зробити перший запит, дізнатися свої ліміти й прочитати робочу інструкцію для агента машинно.
Порядок такий: отримати ключ → GET /me → GET /guide → GET /taxonomy →
робота. Три перші запити займають хвилину й позбавляють половини помилок,
які інакше виявляються вже посеред прогону.
1. Ключ
Ключ видає супер-адмін вручну, один активний на людину. Він показується один раз · далі зберігається лише його відбиток, і відновити рядок неможливо, лише перевипустити.
Ключ передається заголовком X-API-Key у кожному запиті. У URL його не
кладіть ніколи: адреси потрапляють у логи й історію.
2. Хто я і які в мене ліміти
curl -s -H "X-API-Key: $BDO_API_KEY" https://bdo-ua.com.ua/api/agent/v1/me
У відповіді три речі, які варто прочитати до першого прогону:
| Що | Навіщо |
|---|---|
data.effective_abilities |
що ключу справді дозволено після перетину з роллю |
data.limits |
запитів за хвилину, рядків на добу, скільки лишилось і коли скидається |
data.batch |
максимальні розміри пачок: запис, сторінка вибірки, контекст |
Ліміти читайте звідси, а не з памʼяті. Вони змінюються без зміни коду, і зашите в скрипті число почне падати рівно тоді, коли ліміт зменшать.
3. Правила роботи машинно
curl -s -H "X-API-Key: $BDO_API_KEY" https://bdo-ua.com.ua/api/agent/v1/guide
curl -s -H "X-API-Key: $BDO_API_KEY" https://bdo-ua.com.ua/api/agent/v1/taxonomy
/guide · послідовність дій, правила розмітки й української, шаблон промпта,
самоперевірка й таблиця «код помилки → дія». /taxonomy · усі допустимі
значення фільтрів і повний каталог кодів помилок.
Обидва потрібні саме машинно: агент, у якого є лише ключ і URL, не має доступу
до нашого репозиторію, а зашиті в код рядки застаріють при першій зміні.
/guide доступний навіть без здатності читати рядки · правила треба прочитати
ще до першого запиту даних.
Форма кожної відповіді
успіх: { "success": true, "data": { … }, "meta": { … } }
відмова: { "success": false, "error": "<код>", "message": "…", "hint": "…", "details": { … } }
error · машинний код, hint · що робити далі людською мовою. Розбирайте
саме error: текст повідомлення може змінитися, код · ні.
Далі: як брати рядки в роботу.