> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crun.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Flux Kontext Max
> A premium text-based image editing model that delivers maximum performance and improved typography generation for transforming images through natural language prompts
## Query Task Status
After submitting a task, use the unified query endpoint to check progress and retrieve results:
Learn how to query task status and retrieve generation results
For production use, we recommend using the `callback_url` parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.
## Related Resources
Explore all available models
Check credits and account usage
## OpenAPI
````yaml models/flux/flux-kontext-max.json post /api/v1/client/job/CreateTask
openapi: 3.0.0
info:
title: Crun Flux Kontext API
description: crun.ai Flux Kontext API Documentation
version: 1.0.0
contact:
name: Technical Support
email: support@crun.ai
servers:
- url: https://api.crun.ai
description: API Server
security:
- ApiKeyAuth: []
paths:
/api/v1/client/job/CreateTask:
post:
summary: >-
Create a new image generation or editing task using the Flux Kontext
Max.
operationId: flux-kontext-max
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- model
- input
properties:
model:
type: string
enum:
- flux-kontext-max
description: |-
The model name to use for generation. Required field.
- Must be `flux-kontext-max` for this endpoint
callback_url:
type: string
format: uri
description: >-
Optional. Callback URL for receiving task completion
notifications.
- System will POST task status and results to this URL when
generation completes
- Callback payloads structure is consistent with the `data`
object returned by the task status query
- Your callback endpoint should accept POST requests with
JSON payload containing results
- It returns an HTTP 200 status code upon successful receipt
example: https://your-domain.com/api/callback
input:
type: object
description: >-
Input parameters for the Flux Kontext Max image generation
or image editing task
properties:
prompt:
type: string
description: >-
Text description of what you want to generate, or the
instruction on how to edit the given image
minLength: 1
maxLength: 5000
example: >-
A cinematic portrait of a cyberpunk character with neon
lighting.
img_urls:
description: >-
Reference image used for image generation or editing.
Must be jpeg, png, gif, or webp.
oneOf:
- type: array
items:
type: string
format: uri
minItems: 1
maxItems: 1
example:
- https://example.com/reference.png
- type: string
format: uri
example: https://example.com/reference.png
prompt_upsampling:
type: boolean
description: >-
Automatically modify the prompt for more creative
generation
default: false
example: false
aspect_ratio:
type: string
description: >-
Aspect ratio of the generated image. Use
'match_input_image' to match the aspect ratio of the
input image.
enum:
- '1:1'
- '2:1'
- '1:2'
- '2:3'
- '3:2'
- '3:4'
- '4:3'
- '4:5'
- '5:4'
- '9:16'
- '16:9'
- '21:9'
- '9:21'
- match_input_image
default: match_input_image
example: '1:1'
output_format:
type: string
description: Output format for the generated image
enum:
- png
- jpg
default: jpg
example: jpg
seed:
type: integer
description: Random seed. Set for reproducible generation
example: 123456
safety_tolerance:
type: integer
description: >-
Safety tolerance level. 0 is most strict and 6 is most
permissive
minimum: 0
maximum: 6
default: 2
example: 2
required:
- prompt
example:
model: flux-kontext-max
input:
prompt: >-
Transform the image into a cinematic cyberpunk style with neon
lights and rain.
img_urls:
- https://example.com/original_image.png
prompt_upsampling: true
aspect_ratio: match_input_image
output_format: jpg
seed: 42
safety_tolerance: 2
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
task_id:
type: string
description: >-
Task ID, can be used with Get Task Details
endpoint to query task status
example: task_12345678
example:
code: 200
message: success
data:
task_id: task_12345678
'422':
description: Validation Error
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
errors:
type: array
description: Detailed validation error messages
items:
type: string
example:
- specific error field message
example:
code: 422
message: Missing Params or Type Error
errors:
- specific error field message
'500':
$ref: '#/components/responses/Error'
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 455
- 500
- 501
- 505
description: >-
Response status code
- **200**: Success - Request has been processed successfully
- **401**: Unauthorized - Authentication credentials are missing or
invalid
- **402**: Insufficient Credits - Account does not have enough
credits to perform the operation
- **404**: Not Found - The requested resource or endpoint does not
exist
- **422**: Validation Error - The request parameters failed
validation checks
- **429**: Rate Limited - Request limit has been exceeded for this
resource
- **455**: Service Unavailable - System is currently undergoing
maintenance
- **500**: Server Error - An unexpected error occurred while
processing the request
- **501**: Generation Failed - Content generation task failed
- **505**: Feature Disabled - The requested feature is currently
disabled
message:
type: string
description: Response message, error description when failed
example: success
responses:
Error:
description: Server Error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
All APIs require authentication via API Key.
Get API Key:
1. Visit [API Key Management Page](https://crun.ai/user-api-key) to get
your API Key
Usage:
Add to request header:
x-api-key: YOUR_API_KEY
Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately
in the management page
````