Быстрый старт в API
Для работы с сервисом через API вам не требуется активация тарифа. Списание происходит с баланса пользователя согласно стоимости модели нейросети в API.
Некоторые модели могут быть временно недоступны в API. Вы получите соответствующую ошибку.
Генерация ключа
Работа с API осуществляется через API ключ на стороне клиента. Сгенерировать или обновить API ключ можно в настройках API.
Принцип работы
API работает на основе асинхронной пакетной генерации.
Принцип работы прост: отправка запроса и получение taskid → генерация (текст/изображение) → проверка уникальности (опционально) → завершение.
При отправке запроса на /api/v2 ваша задача будет поставлена в очередь на генерацию. Генерация выполняется в фоновом режиме после добавления в очередь. При запросе на добавление генерации в ответном сообщении вы получите task_id задачи, который нужно будет использовать для получения результата генерации.
Для получения результата генерации необходимо отправить второй запрос на /api/v2/status/YOUR_TASK_ID.
Лимиты API
в API предусмотрены минутные и суточные ограничения. Лимиты накладывают ограничение только на /api/v2.
При добавлении большего кол-ва задач в течение минуты выше минутного ограничения вы получите ошибку.
Суточные лимиты обнуляются в 00:00 часов.
| Лимит | Количество |
|---|---|
| В минуту | 7 |
| В день | 5000 |
Стоимость генерации
Стоимость генерации списывается с баланса (начиная с бонусного, если он нулевой, то с реферального, если он также нулевой, то с лицевого).
Расчет стоимости при генерации текста: стоимость = ((кол-во символов запрос + ответ нейросети) / 1000) × цена за 1000 символов.
Расчет стоимости при генерации изображения: стоимость = кол-во сгенерированных изображений × цена за 1 изображение.
Стоимость генераций через API можно узнать на стр. тарифы и цены.
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
| 400 | Неверный запрос. Ошибка в параметрах запроса |
| 401 | Не авторизован. Неверный или отсутствующий токен |
| 403 | Не авторизован. Доступ запрещен |
| 429 | Слишком много запросов. Клиент превысил лимит API |
| 500 | Внутренняя ошибка сервера |
Хранение результатов
Результат генерации хранится в течение 30 дней.
Ошибки и нестандартные ситуации
Если вы получили ошибку и она не описана в документации или не можете правильно составить запрос к API, пожалуйста, сообщите нам в тех. поддержку.
Наша команда обязательно разберет проблему и поможет решить любой вопрос.