Skip to main content
POST
  1. After submission, a task_id will be returned. If you provided a callback_url, when the task status becomes finished or failed, a POST request will be sent to the callback_url.
  2. Regardless of whether callback_url is provided, you can retrieve the result through the unified Query Task Status endpoint.
Flux Kontext is powered by Black Forest Labs. It supports both text-to-image generation and image editing through the same unified submit endpoint.

Models

  • flux-kontext-pro - Flux Kontext Pro text-to-image generation
  • flux-kontext-pro-edit - Flux Kontext Pro image editing, image_urls is required
  • flux-kontext-max - Flux Kontext Max text-to-image generation
  • flux-kontext-max-edit - Flux Kontext Max image editing, image_urls is required

Notes

  • size supports 1:1, 4:3, 3:4, 16:9, 9:16, 21:9, 9:21
  • output_format supports png, jpg
  • image_urls is required for edit models
  • Only image_urls[0] is used as the input image
  • Other downstream fields are not exposed in the current API and use system defaults

Authorizations

Authorization
string
header
required

All API endpoints require Bearer Token authentication.

Create an API key: sign in to PoYo, open Dashboard → API Key at poyo.ai/dashboard/api-key, and click to create a key.

Add it to the request header:

Body

application/json
model
enum<string>
required

Flux Kontext model identifier

Available options:
flux-kontext-pro,
flux-kontext-pro-edit,
flux-kontext-max,
flux-kontext-max-edit
input
object
required

Input parameters for generation

callback_url
string<uri>

Webhook callback URL for result notifications

Example:

"https://your-domain.com/callback"

Response

Task submitted successfully

code
enum<integer>
required

Business status code. 200 means success; any other value means the request failed. Always check this field: some validation errors return HTTP 200 with code: 400 in the body.

  • 200: Success
  • 400: Invalid request parameters
  • 401: Missing or invalid API key
  • 402: Insufficient credits
  • 403: Permission denied
  • 404: Resource not found
  • 408: Request timeout
  • 429: Rate limit exceeded
  • 500: Internal server error
  • 502: Upstream service error
  • 503: Service unavailable

See Error Codes for details.

Available options:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
Example:

200

data
object
required