Skip to main content
Цей документ представить інтеграцію Flux Images Generation API, яка дозволяє генерувати зображення від Flux за допомогою введення користувацьких параметрів.

Процес подачі заявки

Щоб використовувати Flux Images Generation API, спочатку перейдіть до консолі Ace Data Cloud для отримання вашого API Token, зберігайте його для подальшого використання. Якщо ви ще не увійшли в систему або не зареєстровані, вас автоматично перенаправлять на сторінку входу, щоб запросити реєстрацію та вхід, після чого ви будете автоматично повернені на цю сторінку. Один API Token дозволяє викликати всі послуги платформи, не потрібно окремо подавати заявку на кожну послугу. Перший запит на отримання токена надає безкоштовний ліміт, щоб ви могли безкоштовно протестувати; якщо ліміт вичерпано, ви можете поповнити загальний баланс в консолі.
📘 Повна документація: Flux Images Generation API →

Основне використання

Спочатку розгляньте основний спосіб використання, тобто введіть підказку prompt, дію action, розмір зображення size, і ви отримаєте оброблений результат. Спочатку потрібно просто передати поле action, значення якого буде generate, потім ми також повинні ввести підказку, конкретний зміст наведено нижче:

Ми можемо бачити, що тут ми налаштували заголовки запиту, включаючи:
  • accept: вкажіть, у якому форматі ви хочете отримати відповідь, тут вказано application/json, тобто формат JSON.
  • authorization: ключ для виклику API, після подачі заявки ви можете вибрати його зі списку.
Також налаштовано тіло запиту, яке включає:
  • action: дія для цього завдання з генерації зображення.
  • size: розмір згенерованого зображення. Серії flux-2-flex / flux-2-pro / flux-2-max повинні передавати співвідношення зображення (наприклад, 1:1, 16:9), не приймаються піксельні розміри на кшталт 1024x1024, за замовчуванням повертається 400.
  • count: кількість згенерованих зображень, значення за замовчуванням - 1, цей параметр дійсний лише для завдань генерації зображень, для редагування він недійсний.
  • prompt: підказка.
  • model: модель генерації, за замовчуванням flux-dev; останніми флагманами є flux-2-pro, flux-2-max (вища якість, потрібно поєднувати з співвідношенням зображення size).
  • callback_url: URL, на який потрібно повернути результати.
  • async: необов’язковий, якщо встановити в true, інтерфейс негайно повертає task_id, не потрібно надавати callback_url, потім через відповідний інтерфейс запиту завдань можна опитувати для отримання результатів.
Параметр size має деякі особливі обмеження, які в основному поділяються на два типи: співвідношення width x height та співвідношення x:y, конкретно: Приклади співвідношень зображення: “21:9”, “16:9”, “4:3”, “3:2”, “1:1”, “2:3”, “3:4”, “9:16”, “9:21”. Після вибору параметрів праворуч автоматично згенерується відповідний код. Перед копіюванням переконайтеся, що заголовок авторизації використовує ваш власний API Key, у документації та скріншотах не повинно бути реальних облікових даних. Натисніть кнопку «Спробувати», щоб провести тестування, тут ми отримали наступний результат:
У повернутому результаті є кілька полів, описаних нижче:
  • success, статус завдання генерації відео на даний момент.
  • task_id, ID завдання генерації відео на даний момент.
  • trace_id, ID відстеження генерації відео на даний момент.
  • data, список результатів завдання генерації зображення на даний момент.
    • image_url, посилання на завдання генерації зображення на даний момент.
    • prompt, підказка.
Ми можемо бачити, що отримали задовільну інформацію про зображення, нам потрібно лише отримати згенероване зображення Flux за адресою посилання з data. Крім того, якщо ви хочете згенерувати відповідний код інтеграції, ви можете просто скопіювати його, наприклад, код CURL виглядає так:

Редагування завдання зображення

Якщо ви хочете редагувати певне зображення, спочатку параметр image_url повинен містити посилання на зображення, яке потрібно редагувати, у цьому випадку action підтримує лише edit, ви можете вказати наступні змісти:
  • model: модель, що використовується для редагування зображення, підтримує flux-dev, flux-pro, flux-kontext-pro, flux-kontext-max, flux-2-flex, flux-2-pro, flux-2-max.
  • image_url: завантажте зображення, яке потрібно редагувати.
Приклад заповнення наведено нижче:

Після заповнення автоматично згенерувався код, як показано нижче:

Відповідний код:
Натиснувши «Запустити», ви можете побачити, що відразу отримаєте результат, як показано нижче:
Можна побачити, що згенерований ефект є ефектом редагування оригінального зображення, результат схожий на вищезазначений.

Асинхронний зворотний виклик

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

Натиснувши “Запустити”, можна помітити, що відразу отримано результат, як показано нижче:
Почекавши деякий час, ми можемо спостерігати результати згенерованого зображення на 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: Внутрішня помилка сервера, щось пішло не так на сервері.

Приклад відповіді з помилкою

Висновок

Завдяки цьому документу ви вже дізналися, як використовувати API Flux Images Generation для генерації зображень за допомогою введення підказок. Сподіваємося, що цей документ допоможе вам краще інтегрувати та використовувати цей API. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої технічної підтримки.