1. Справочный центр
  2. Документы
  3. API Gerwin
API Gerwin
Обновлено: 14 ноября 2022 г.

Внимание, API находится в режиме бета-тестирования. Заявки принимаются в ручном режиме и в ограниченном количестве

Схема работы

Подключение

Перед подключением API необходимо пополнить баланс аккаунта минимум на 1 000 000 символов. Далее, чтобы подключить API напишите в службу технической поддержки support@gerwin.io

Документация

Изучите документацию по использованию API в swagger или redoc.
В данный момент в API доступно 2 языка генерации текста 🇷🇺 Русский и 🇬🇧 Английский.
Все навыки, доступные для работы через API определяются документацией.

Аутентификация

Для аутентификации передайте адрес электронной почты и пароль в метод login, в ответ вы получите токен. В дальнейшем, все запросы к api должны содержать в заголовке токен, который выдается при аутентификация

Используйте API

Для того, чтобы использовать навыки из API вам необходимо в каждом запросе передавать токен, полученные на предыдущем шаге. После отправки запроса в метод, в ответ вы получаете идентификатор и статус задачи.

Задачи

Все задачи выполняются в фоновом режиме. Вы можете использовать вебхуки, для автоматической отправки результата выполнения задачи на ваш url адрес, который вы указываете в параметре callback. Для тестирования работы вебхуков можете использовать этот сервис.
Так же статус и результат выполнения задачи можно получать вручную, используя метод из документации.
Время выполнения 1 задачи зависит от многих факторов и может варьироваться, но в среднем составляет до 1 минуты.

Ограничение использования

API нашего сервиса имеет ограничение по количеству запросов. С одного аккаунта вы можете отправлять не чаще, чем 1 запрос в 4 секунды.

Использование API

Чтобы все запросы работали корректно, вы должны соблюдать ряд условий:

  1. Баланс вашего аккаунта всегда должен быть положительным
  2. Ваш аккаунт не должен быть заблокирован
  3. API должен быть подключен для вашего аккаунта (обращаться в службу технической поддержки support@gerwin.io)
  4. Все запросы должны проходить валидацию (проверку на правильное заполнение входных данных)
  5. Отправлять запросы можно не чаще, чем 1 раз в 4 секунды
  6. Запросы должны проходить фильтр контента

Приятного использования,
команда Gerwin AI!