Flux Kontext

Overview

Flux Kontext is an image-to-image model that supports editing and generation based on existing images. This model offers three versions: Dev, Pro, and Max.


Test API KEY: key_00000000000000000000000000000000

Endpoints

1. Create Task

Request


POST https://api.pixwith.ai/api/task/create

Headers

Header	Value	Required
Content-Type	application/json	Yes
Api-Key	{API_KEY}	Yes

Request Parameters

Parameter	Type	Required	Description
prompt	string	Yes	The input prompt (e.g., “Put a hat on the cat”)
image_urls	array	Yes	[“https://cdn.pixwith.ai/xxx.jpg ”]. Provide 1 image.
model_id	string	Yes	`1-1` (Dev), `1-2` (Pro), or `1-3` (Max)
options	object	Yes	Configuration options for the task
options.prompt_optimization	boolean	Yes	If true, all prompt words will be automatically translated into English.
options.aspect_ratio	string	Yes	Aspect ratio of the output. Valid values: `'0'` (match original image), `'1:1'`, `'3:4'`, `'2:3'`, `'9:16'`, `'4:3'`, `'3:2'`, or `'16:9'`. Default: `'0'`

Example Request


{
  "prompt": "Put a hat on the cat",
  "image_urls": [
    "https://cdn.pixwith.ai/images/cf0ddb5ad6a0f0c85ab4d1dceb9fd89c_0.jpeg"
  ],
  "model_id": "1-1",
  "options": {
    "prompt_optimization": true,
    "aspect_ratio": "0"
  }
}

Response Parameters

Parameter	Type	Description
code	int	1=success, 0=error
message	string	Success and failure messages
data	object
data.task_id	string
data.estimated_time	int	Estimated time in seconds

Response


{
  "code": 1,
  "message": "success",
  "data": {
    "task_id": "d425ab4dc256f0ebaa84862b9cea8a3d",
    "estimated_time": 5
  }
}