API перевірки текстуза ключем і звичайним JSON.
Той самий аналіз, що й на сайті, але для ваших програм: оцінка, метрики, місця в тексті з цитатами, очищення та розмітка. Запити й відповіді - у JSON.
- знаків у запиті
- ...
- запитів одразу
- ...
- запитів на сек.
- ...
- на місяць
- ...
curl -s https://authortext.com/api/analyze \ -H "Authorization: Bearer atk_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"text": "It is important to note that various factors play a crucial role."}'200 OK/ application/json/ Відповідь скорочено: показано не всі поля
{ "probability": 36.048, "confidence": "LOW", "band": { "index": 2, "key": "mixed" }, "evidence": [ { "type": "phrase", "line": 1, "why": "high", "excerpt": ">>>It is important to note<<< that various ..." } ], "stats": { "words": 12, "sentences": 1 }}01/Ендпоїнти
Ключ приймають ці запити; запити кабінету й оплати ключ не приймають.
- POST
/api/analyzeОцінка, метрики, місця в тексті з цитатами, водяні знакитіло: {"text": "..."} 1 запит - POST
/api/cleanОчищення: видалення прихованих символів і типографіки; надто довгий текст обрізається до ліміту тарифу (truncated, limit)тіло: {"text": "..."} 1 запит - POST
/api/highlightРозмітка знайдених місць для підсвічуваннятіло: {"text": "..."} 1 запит - POST
/api/fetch-urlЗавантаження сторінки за адресою та аналіз її текстутіло: {"url": "..."} 5 запитів - POST
/api/extract-fileТекст із файлу: PDF, DOCX, ODT, RTF, EPUB, FB2, HTML, TXTтіло: файл 5 запитів - GET
/api/meТариф ключа та його межі не витрачає запити
02/Що важливо знати
Без зберігання
Текст обробляється в пам'яті, не пишеться на диск і не потрапляє в журнали.
Ключ і тариф
Ключ створюється в кабінеті й показується один раз; сервер зберігає лише відбиток. Новий ключ замінює попередній.
Один формат помилок
Помилка завжди має вигляд {"error": {"code", "message"}}, без трасувань.
Текст, посилання, файл
Можна надіслати текст, адресу сторінки або документ цілком.
03/API за ключем: тарифи «Про» і «Макс»
Ціни й ліміти беруться з сервера, тому не розходяться зі справжніми.- Ключ API входить у тарифи «Про» і «Макс».
- Усі види аналізу та розбір за фрагментами
- Заголовок Authorization: Bearer для аналізу, очищення, розмітки, завантаження за посиланням і з файлу
- Ключ діє, поки триває оплачений період
04/Помилки та обмеження
| Код HTTP | code | Коли |
|---|---|---|
| 400 | invalid_json | Тіло запиту не є коректним JSON |
| 413 | payload_too_large | Тіло запиту завелике |
| 415 | unsupported_media_type | Content-Type не application/json |
| 422 | empty_text / invalid_text | Поле text порожнє, відсутнє або не рядок |
| 422 | text_too_long | Текст довший за межу тарифу; у відповіді limit і plan |
| 429 | rate_limited | Занадто часто; дивіться заголовок Retry-After |
- Запити рахуються «пачкою»: спершу можна надіслати стільки запитів поспіль, скільки вказано вище, а далі - стільки на секунду. Завантаження за посиланням або з файлу коштує 5 запитів. Текст довший за 100 000 знаків коштує ще по 1 запиту за кожні 100 000.
- Якщо ключа немає, він хибний або прострочений, помилки не буде: запит обробиться як безкоштовний, з безкоштовними межами (3 000 знаків). Який у вас тариф, дізнаєтеся через GET /api/me.
- Оцінка - орієнтир, а не доказ авторства.
// API KEY
Відкрити кабінетКлюч створюється в кабінеті
Оформіть підписку «Про» або «Макс», відкрийте розділ «Ключ API» в кабінеті й натисніть «Створити ключ».