Процес подачі заявки
Щоб використовувати API, спочатку потрібно перейти на сторінку Flux Images Generation API для подачі заявки на відповідну послугу. Після переходу на сторінку натисніть кнопку «Acquire», як показано на малюнку:
Якщо ви ще не увійшли в систему або не зареєстровані, вас автоматично перенаправлять на сторінку входу, щоб запросити реєстрацію та вхід. Після входу або реєстрації ви автоматично повернетеся на поточну сторінку.
При першій подачі заявки вам буде надано безкоштовний ліміт, який дозволяє безкоштовно використовувати цей API.
Основне використання
Спочатку потрібно ознайомитися з основним способом використання, а саме: введенням підказкиprompt, дії action, розміру зображення size, щоб отримати оброблений результат. Спочатку потрібно просто передати поле action, значення якого буде generate, потім потрібно ввести підказку, конкретний зміст якої наведено нижче:

accept: формат відповіді, який ви хочете отримати, тут вказаноapplication/json, тобто формат JSON.authorization: ключ для виклику API, після подачі заявки ви можете вибрати його зі списку.
action: дія для завдання генерації зображення.size: розмір згенерованого зображення.count: кількість згенерованих зображень, значення за замовчуванням - 1, цей параметр дійсний лише для завдань генерації зображень, для редагування він недійсний.prompt: підказка.model: модель генерації, за замовчуваннямflux-dev.callback_url: URL для отримання результатів.
size має деякі особливі обмеження, які в основному поділяються на два типи: співвідношення ширини до висоти width x height та співвідношення зображення x:y, конкретно наведено нижче:
| Модель | Діапазон |
|---|---|
| flux-2-flex | Підтримує співвідношення ширини до висоти x >= 64, має бути кратним 32 |
| flux-2-pro | Підтримує співвідношення ширини до висоти x >= 64, має бути кратним 32 |
| flux-2-max | Підтримує співвідношення ширини до висоти x >= 64, має бути кратним 32 |
| flux-pro-1.1 | Підтримує співвідношення ширини до висоти 256 <= x <= 1440, має бути кратним 32 |
| flux-dev | Підтримує співвідношення ширини до висоти 256 <= x <= 1440, має бути кратним 32 |
| flux-pro-1.1-ultra | Не підтримує співвідношення ширини до висоти, підтримує співвідношення зображення |
| flux-kontext-pro | Не підтримує співвідношення ширини до висоти, підтримує співвідношення зображення |
| flux-kontext-max | Не підтримує співвідношення ширини до висоти, підтримує співвідношення зображення |

success: статус завдання генерації відео.task_id: ID завдання генерації відео.trace_id: ID відстеження генерації відео.data: список результатів завдання генерації зображення.image_url: посилання на завдання генерації зображення.prompt: підказка.
data.
Крім того, якщо ви хочете згенерувати відповідний код інтеграції, ви можете просто скопіювати його, наприклад, код CURL виглядає так:
Редагування завдання зображення
Якщо ви хочете редагувати певне зображення, спочатку параметрimage_url повинен містити посилання на зображення, яке потрібно редагувати, у цьому випадку action підтримує лише edit, і ви можете вказати наступні параметри:
- model: модель, яка використовується для редагування зображення, ця задача наразі підтримує
flux-kontext-max,flux-kontext-pro. - image_url: завантажте зображення, яке потрібно редагувати.


Асинхронний зворотний виклик
Оскільки час генерації зображень за допомогою API Flux Images Generation є відносно тривалим, приблизно 1-2 хвилини, якщо API довго не відповідає, HTTP запит буде постійно підтримувати з’єднання, що призведе до додаткових витрат системних ресурсів, тому цей API також надає підтримку асинхронних зворотних викликів. Загальний процес такий: коли клієнт ініціює запит, додатково вказується полеcallback_url, після ініціації запиту API відразу повертає результат, що містить інформацію про поле task_id, яке представляє поточний ідентифікатор завдання. Коли завдання завершено, результат генерації зображення буде надіслано на вказаний клієнтом callback_url у форматі POST JSON, в якому також міститься поле task_id, таким чином результати завдання можна пов’язати за допомогою ID.
Далі ми розглянемо приклад, щоб зрозуміти, як саме це працює.
По-перше, зворотний виклик Webhook — це сервіс, який може приймати HTTP запити, розробники повинні замінити його на URL свого HTTP сервера. Для зручності демонстрації використовується публічний зразок сайту Webhook https://webhook.site/, відкривши цей сайт, ви отримаєте URL Webhook, як показано на малюнку:
Скопіюйте цей URL, і ви зможете використовувати його як Webhook, приклад тут: https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab.
Далі ми можемо налаштувати поле callback_url на вказаний вище URL Webhook, одночасно заповнивши відповідні параметри, конкретний зміст, як показано на малюнку:

https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab, як показано на малюнку:
Зміст такий:
task_id, інші поля схожі на вищезгадані, за допомогою цього поля можна реалізувати зв’язок завдань.
Обробка помилок
При виклику API, якщо виникає помилка, API поверне відповідний код помилки та інформацію. Наприклад:400 token_mismatched: Неправильний запит, можливо, через відсутні або недійсні параметри.400 api_not_implemented: Неправильний запит, можливо, через відсутні або недійсні параметри.401 invalid_token: Неавторизовано, недійсний або відсутній токен авторизації.429 too_many_requests: Занадто багато запитів, ви перевищили ліміт запитів.500 api_error: Внутрішня помилка сервера, щось пішло не так на сервері.

