Z-Image
POST
/api/v1/jobs/createTask
Model Value
z-imageRequest Body
| Field | Type | Required | Notes |
|---|---|---|---|
model | string | Yes | Must be z-image. |
callBackUrl | string | No | Public HTTPS URL for final callback. |
input.prompt | string | Yes | Non-empty prompt. |
input.image_size | string | No | Defaults to square_hd. Sent directly to Magnific. |
input.aspect_ratio | string | No | Alternative to image_size; common ratios map to image sizes. |
input.seed | integer | No | Optional deterministic seed. |
input.num_inference_steps | integer | No | Optional upstream step count. |
input.output_format | string | No | Optional upstream output format, for example png. |
input.enable_safety_checker | boolean | No | Optional upstream safety checker flag. |
image_size and aspect_ratio are provided, image_size takes priority.Minimal Runnable Example
model and input.prompt are required. Add optional fields from the table above only when your use case needs them. To receive a webhook, add a top-level callBackUrl field with a public HTTPS URL.Query Task Status
GET /api/v1/jobs/recordInfo?taskId=... to retrieve progress and final results. For production usage, pass callBackUrl when creating the task and still keep polling as a fallback.Callback
callBackUrl is optional. When provided, LiangXin sends the same payload shape as recordInfo after the task reaches success or fail. Your server should return any 2xx status. Webhook delivery is retried briefly, but clients should not rely on webhooks only.Response And Error Format
200 and a public taskId. Store this ID and query it with GET /api/v1/jobs/recordInfo.{
"code": 400,
"msg": "input.prompt is required",
"data": null
}{
"error": {
"message": "invalid token",
"type": "new_api_error",
"code": ""
}
}400 invalid request, missing model, unsupported model, invalid model parameter, or price not configured; 401 invalid or missing API key; 403 insufficient quota or access denied; 413 request body too large; 422 upstream validation rejected the request; 429 current group/upstream load is saturated; 500 upstream or internal task error.Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/jobs/createTask' \
--header 'Content-Type: application/json' \
--data-raw '{
"model": "z-image",
"input": {
"prompt": "Generate a photorealistic image of a cafe terrace in Paris on a crisp spring morning"
}
}'Response Response Example
200 - 200 - Task accepted
{
"code": 200,
"msg": "success",
"data": {
"taskId": "task_z-image_1777600000000"
}
}Modified at 2026-05-01 06:34:47