КОНТРАКТ МЕЖДУ ФРОНТЕНДОМ И БЭКЕНДОМ

Ваш первый API.

API — набор адресов, по которым интерфейс обращается к серверу. Попробуйте запрос справа и посмотрите на ответ. Пример использует бесплатную тестовую модель. Подключённые платные модели перечислены в каталоге.

Операции

GET /api/v1/health

Проверяет доступность сервера, базы и обработчика.

GET /api/v1/models

Возвращает доступные модели и описание их входных параметров.

POST /api/v1/generations

Создаёт задание. HTTP 202 означает «принято в обработку». Передайте JSON и заголовок Idempotency-Key.

GET /api/v1/generations/{id}

Возвращает текущее состояние. Опрос раз в секунду позволяет показать результат без постоянного открытого запроса.

GET /api/v1/generations?limit=20&offset=0

История: limit — сколько записей вернуть, offset — сколько пропустить.

POST /api/v1/generations/{id}/resume

Продолжает проверку сохранённого запроса fal без новой генерации.

GET /api/v1/generations/{id}/asset

Возвращает сохранённое изображение fal.

При сетевой ошибке повторите POST с тем же ключом и телом. После принятого задания для нового запуска создайте новый ключ. Один ключ с другим телом вернёт HTTP 409.

Адрес результата в assets[].url относительный: добавляйте к нему адрес бэкенда, если фронтенд запущен на другом порту. Схема OpenAPI доступна по ссылке сверху. Эта страница — простой локальный клиент API; Swagger UI пока не установлен.

Отправить запрос

Ответ сервера появится ниже.

{ }