Быстрый старт

Введение

GenAPI предоставляет единый API для доступа к широкому спектру нейросетей. В этом руководстве вы за 5 минут сделаете первый запрос к API и получите результат генерации.

Шаг 1: Создание API-ключа

Для работы с API необходимо создать ключ аутентификации.

  1. Перейдите на страницу API ключи.
  2. Нажмите на кнопку «Создать новый ключ».
  3. Скопируйте полученный ключ.

Шаг 2: Выбор нейросети

GenAPI объединяет сотни моделей для различных задач:

Для выбора модели:

  1. Перейдите в раздел Нейросети.
  2. Выберите нужную категорию или воспользуйтесь поиском.
  3. Откройте страницу модели и скопируйте её идентификатор (например, flux-2).
Пример получения идентификатора модели
Идентификатор модели указан в URL и на странице модели.

Шаг 3: Отправка запроса на генерацию

Базовый формат запроса

Запрос на генерацию отправляется методом POST на адрес:

POST

https://api.gen-api.ru/api/v1/networks/{network_id}

network_id - идентификатор модели из предыдущего шага (например, flux-2).

Полная спецификация запроса описана на странице Запрос в нейросеть.

Тело запроса (Payload)

В зависимости от модели и типа генерации, тело запроса может содержать различные параметры. Базовый пример для генерации изображения:

Авторизация

API-ключ передаётся в заголовке Authorization:

Шаг 4: Получение результата

Для получения результата генерации используйте GET-запрос к:

GET

https://api.gen-api.ru/api/v1/request/get/{request_id}

request_id - ID запроса из ответа на Шаге 3 (например, 1234567890).

Полная спецификация ответа описана на странице Получение результата.

Способы получения результата

GenAPI поддерживает несколько способов получения результатов генерации. Вы можете выбрать наиболее подходящий для вашего случая:

  • GET-запрос — базовый способ получения результата, описанный выше. Подробнее в разделе Получение результата.
  • Webhook — асинхронный способ получения результата. GenAPI отправит POST-запрос на указанный вами URL после завершения генерации. Подробнее в разделе Webhooks.
  • Синхронный режим — режим, в котором ответ на запрос генерации приходит только после завершения обработки. Подробнее в разделе Синхронные запросы.
  • Stream — потоковый режим для получения частичных результатов в реальном времени (доступен для некоторых моделей). Подробнее в разделе Stream.

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

application/json

id

integer

required

status

string

required

response_type

string

required

cost

integer

required

progress

integer

required

runtime

number

required

result

array [string]

required

full_response

array [object]

required

parameters

object

required

timestamp

integer

required

application/json

error

string

required

application/json

error

string

required

Пример использования

Генерация изображения (Flux 2)

1. Отправка запроса на генерацию.

Пример запроса

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

2. Получение результата.

Пример запроса

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