Appearance
Flux-2 - Text to Image
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Flux-2 - Text to Image
deprecated: false
description: >
High-quality photorealistic image generation powered by Flux-2's
advanced AI model
## Query Task Status
After submitting a task, use the unified query endpoint to check
progress and retrieve results:
**Get Task Details**
Learn how to query task status and retrieve generation results
::: tip[]
For production use, we recommend using the `callBackUrl` parameter to
receive automatic notifications when generation completes, rather than
polling the status endpoint.
:::
## Related Resources
**Market Overview**
Explore all available models
**Common API**
Check credits and account usage
operationId: flux-2-flex-text-to-image
tags:
- docs/en/Market/Image Models/Flux-2
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
properties:
model:
type: string
enum:
- flux-2/flex-text-to-image
default: flux-2/flex-text-to-image
description: >-
Model name for the generation task. Required field.
- This endpoint must use the `flux-2/flex-text-to-image`
model
examples:
- flux-2/flex-text-to-image
callBackUrl:
type: string
format: uri
description: >-
Callback URL to receive notifications when the generation
task is completed. Optional configuration, recommended for
production environments.
- After the task is generated, the system will POST task
status and results to this URL
- The callback content includes the generated resource URL
and task-related information
- Your callback endpoint needs to support receiving POST
requests with JSON payloads
- Alternatively, you can call the task details endpoint to
actively poll task status
- To ensure callback security, see [Webhook Verification
Guide](/common-api/webhook-verification) for signature
verification implementation
examples:
- https://your-domain.com/api/callback
input:
type: object
description: Input parameters for the generation task
properties:
prompt:
description: >-
Generation prompt, length must be between 3-5000
characters. (Maximum length: 5000 characters)
type: string
maxLength: 5000
examples:
- >-
A humanoid figure with a vintage television set for a
head, featuring a green-tinted screen displaying a
`Hello FLUX.2` writing in ASCII font. The figure is
wearing a yellow raincoat, and there are various wires
and components attached to the television. The
background is cloudy and indistinct, suggesting an
outdoor setting
aspect_ratio:
type: string
description: >-
Aspect ratio of the generated image. When `auto` is
selected, it will match the ratio of the first input
image (requires input image to be provided).
enum:
- '1:1'
- '4:3'
- '3:4'
- '16:9'
- '9:16'
- '3:2'
- '2:3'
default: '1:1'
examples:
- '1:1'
x-apidog-enum:
- value: '1:1'
name: ''
description: ''
- value: '4:3'
name: ''
description: ''
- value: '3:4'
name: ''
description: ''
- value: '16:9'
name: ''
description: ''
- value: '9:16'
name: ''
description: ''
- value: '3:2'
name: ''
description: ''
- value: '2:3'
name: ''
description: ''
resolution:
description: Output image resolution.
type: string
enum:
- 1K
- 2K
default: 1K
examples:
- 1K
nsfw_checker:
type: boolean
description: >-
Defaults to false. You can set it to false based on your
needs. If set to false, our content filtering will be
disabled, and all results will be returned directly by
the model itself.
required:
- prompt
- aspect_ratio
- resolution
x-apidog-orders:
- prompt
- aspect_ratio
- resolution
- nsfw_checker
x-apidog-ignore-properties: []
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: flux-2/flex-text-to-image
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
A humanoid figure with a vintage television set for a head,
featuring a green-tinted screen displaying a `Hello FLUX.2`
writing in ASCII font. The figure is wearing a yellow
raincoat, and there are various wires and components attached
to the television. The background is cloudy and indistinct,
suggesting an outdoor setting
aspect_ratio: '1:1'
resolution: 1K
nsfw_checker: false
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_flux-2_1765175490366
headers: {}
x-apidog-name: ''
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
x-apidog-folder: docs/en/Market/Image Models/Flux-2
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506367-run
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
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
- **433**: Request Limit - Sub-key Usage Exceeds Limit
- **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
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 433
- 455
- 500
- 501
- 505
x-apidog-enum:
- value: 200
name: ''
description: ''
- value: 401
name: ''
description: ''
- value: 402
name: ''
description: ''
- value: 404
name: ''
description: ''
- value: 422
name: ''
description: ''
- value: 429
name: ''
description: ''
- value: 433
name: ''
description: ''
- value: 455
name: ''
description: ''
- value: 500
name: ''
description: ''
- value: 501
name: ''
description: ''
- value: 505
name: ''
description: ''
msg:
type: string
description: Response message, error description when failed
examples:
- success
data:
type: object
properties:
taskId:
type: string
description: >-
Task ID, can be used with Get Task Details endpoint to query
task status
x-apidog-orders:
- taskId
required:
- taskId
x-apidog-ignore-properties: []
x-apidog-orders:
- code
- msg
- data
title: response not with recordId
required:
- data
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
BearerAuth:
type: bearer
scheme: bearer
bearerFormat: API Key
description: |-
所有 API 都需要通过 Bearer Token 进行身份验证。
获取 API Key：
1. 访问 API Key 管理页面 获取您的 API Key
使用方法：
在请求头中添加：
Authorization: Bearer YOUR_API_KEY
注意事项：
- 请妥善保管您的 API Key，切勿泄露给他人
- 若怀疑 API Key 泄露，请立即在管理页面重置
BearerAuth1:
type: bearer
scheme: bearer
bearerFormat: API Key
description: |-
所有 API 都需要通过 Bearer Token 进行身份验证。
获取 API Key：
1. 访问 API Key 管理页面 获取您的 API Key
使用方法：
在请求头中添加：
Authorization: Bearer YOUR_API_KEY
注意事项：
- 请妥善保管您的 API Key，切勿泄露给他人
- 若怀疑 API Key 泄露，请立即在管理页面重置
servers:
- url: https://api.kie.ai
description: 正式环境
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []