Skip to main content
Skip to main content

Flux 3 Image

Flux 3 Image

  • 99.9% SLA
  • Official Discounts
  • Pay-as-you-go
  • Fast & Low Latency
Brand:Black Forest LabsPrice: From $0.041

API DOCS / SIMPLIFIED

Integrate this model with one task-based API flow

Flux 3 Image The examples below are rendered from Flux 3 Image, the current gateway base URL, and the selected public model contract.

Input mode
X-API-Key on every request
POST /api/v1/openapi/task
GET /api/v1/openapi/task/status/{task_id}
Async task workflow

Single code window

Switch language once. Each example already includes both the task creation request and the task status polling request.

Unified Example
API_KEY="<API_KEY>"
BASE_URL="https://api.musespark.ai"
REQUEST_BODY='{
  "model_id": "flux-3-image",
  "parameters": {
    "prompt": "A cinematic portrait with soft lighting",
    "resolution": "1K",
    "aspect_ratio": "1:1",
    "grounding": false,
    "batch_size": 1
  }
}'

CREATE_RESPONSE=$(curl --request POST "$BASE_URL/api/v1/openapi/task" \
  --header "X-API-Key: $API_KEY" \
  --header "Content-Type: application/json" \
  --data-raw "$REQUEST_BODY")

TASK_ID="<TASK_ID_FROM_CREATE_RESPONSE>"

curl "$BASE_URL/api/v1/openapi/task/status/$TASK_ID" \
  --header "X-API-Key: $API_KEY"

Request and response JSON become the documentation

Keep the payload and task status envelope as the primary contract. Field descriptions, optionality, and enum hints now live inline as JSON comments.

Request Body

Caller payload

This is the request envelope accepted by the public gateway for the selected model contract.

Field comments and caller parameters come directly from the current item's model schema.
{
"model_id": "flux-3-image",// target model
"parameters": {
"prompt": "A cinematic portrait with soft lighting",// describe the image or reference-image edit with a nonblank prompt. Use positive instructions; negative prompts are unsupported · min 1 · min length 1
"resolution": "1K",// default 1k; 768 aliases 768sq · enum: 768sq | 1K | 1.5K | 2K | 4K
"aspect_ratio": "1:1",// choose the output aspect ratio. Auto selects the image shape automatically · enum: 21:9 | 2:1 | 16:9 | 3:2 | 7:5 | 4:3 | 5:4 | 1:1 | 4:5 | 3:4 | 5:7 | 2:3 | 9:16 | 1:2 | 9:21 | auto
"grounding": false,// allow web or image search before generation
"batch_size": 1// museSpark batch count; each child task requests one provider output · min 1 · max 15
}
}
Response Body

Gateway response

This is the task status response you will query with task_id until the task reaches a terminal state.

Poll every 2-5 seconds and stop once status becomes completed, failed, cancelled.
{
"code": 200,// 200 on success
"msg": "success",
"data": {
"task_id": "task_01HQX8N2QJ0YQ8Q0T7G6N4V6K2",// use for status polling
"status": "completed",// enum: queued | running | completed | failed | cancelled
"progress": 100,// 0-100 if available
"completed_at": 1760000000,// unix timestamp
"expires_at": 1760001800,// unix timestamp
"result": {
"output_urls": [// generated files
"https://cdn.example.com/output.png"
]
}
}
}