Схема работы

Авторизация

Чтобы наше API могло идентифицировать запрос, вам необходимо указывать в нем следующий заголовок:

Получить ключ можно здесь.

Чтобы получить информацию о пользователе, необходим такой запрос

Запрос на генерацию

Запрос генерации отправляется на следующий URL:

Если вы работаете с функциями, то запрос отправляется на следующий URL:

Узнать id нейросети можно на странице самой нейросети.

У каждой модели есть свои параметры. Ознакомьтесь с ними на странице нейросети в разделе API.

У GenAPI есть несколько способов получения результата:

1. Long-pooling
2. На Callback URL
3. Получение результата в ответе на запрос.

Long-pooling

Самый простой и надёжный способ, который применяется по умолчанию и не требует дополнительных настроек.

Примерное содержание ответа на запрос:

Сообщение означает, что система приняла задачу в работу и присвоила ей номерrequest_id

Теперь необходимо подождать некоторое время, которое зависит от нейросети и параметров.

Чтобы узнать о статусе задачи необходимо отправить запрос на следующий URL:

Отправляйте этот запрос, чтобы узнать статус задачи. Но помните, что любой нейросети требуется хотя бы несколько секунд на обработку.

Пример ответа:

Ваша задача может иметь разный статус (status):

• processing - задача в работе, повторите позже.
• failed - задача не выполнена.
• success - задача готова.

Callback URL

Добавьте к запросу параметр callback_url и мы оповестим вас о статусе задачи.

Способ не подойдёт, если приложение не подразумевает наличие собственных URL-адресов.

Пример ответа:

Пример ошибки:

Сразу ответ

В этом способе ответ придет в самом запросе на генерацию. Необходимо дополнительно отправить параметр is_sync со значением true.

ВАЖНО! Не все нейросети поддерживают такой способ работы, уточняйте в параметрах.

Не самый надёжный и практичный способ, если вы строите систему с перспективой масштабирования. При этом варианте ошибки могут случаться чаще и вам придется обрабатывать их на своей стороне. Также увеличивается время ожидания ответа.

Тем не менее такой способ отлично подойдет для тех, кто использует API для себя.

Функции

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

Запрос к Функции

Для запроса к функции вам потребуется передать {slug} реализации который вы получили выше и обязательные параметры которые вы можете найти на странице выбраной вами функции.

Запрос на генерацию функций отправляется на следующий URL:

Пример передаваемых данных:

Возможные ошибки