Seedream5.0 Pro - Text to Image

This page is generated from the upstream official OpenAPI documentation. Endpoints, parameters and examples match the official docs; brand and API domain are replaced with ModelFold.

Endpoint

POST /jobs/createTask

Full URL: https://ai.modelfold.online/v1/jobs/createTask

Authentication: every request must include the Authorization: Bearer <API_KEY> header.

High-quality photorealistic image generation powered by Seedream'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.

Market Overview — Explore all available models
Common API — Check credits and account usage

Request Parameters

Body (application/json)

Parameter	Type	Required	Description
`model`	`string`	Yes	The model name to use for generation. Required field. - Must be `seedream/5-pro-text-to-image` for this endpoint Default：`"seedream/5-pro-text-to-image"`。 Allowed values：`seedream/5-pro-text-to-image`。示例：`seedream/5-pro-text-to-image`。
`callBackUrl`	`string`	No	The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see Webhook Verification Guide for signature verification implementation 示例：`https://your-domain.com/api/callback`。
`input`	`object`	Yes	Input parameters for the generation task
`input.prompt`	`string`	Yes	Text prompt, 4–5000 characters. 示例：`A full-process cafe design tool for entrepreneurs and designers. It covers core needs including store layout, functional zoning, decoration style, equipment selection, and customer group adaptation, supporting integrated planning of "commercial attributes + aesthetic design." Suitable as a promotional image for a cafe design SaaS product, with a 16:9 aspect ratio.`。
`input.aspect_ratio`	`string`	Yes	Required. Width-height ratio of the image, determining its visual form. Allowed values：`1:1` / `4:3` / `3:4` / `16:9` / `9:16` / `2:3` / `3:2` / `21:9`。示例：`1:1`。
`input.quality`	`string`	Yes	Required. Basic outputs 1K images, while High outputs 2K images. Allowed values：`basic` / `high`。示例：`basic`。
`input.output_format`	`string`	No	Format of the output image Default：`"png"`。 Allowed values：`png` / `jpeg`。示例：`png`。
`input.nsfw_checker`	`boolean`	No	Defaults to false. When false, no additional content filtering is applied and results are returned directly by the model.

Request Example

bash

curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "seedream/5-pro-text-to-image",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A full-process cafe design tool for entrepreneurs and designers. It covers core needs including store layout, functional zoning, decoration style, equipment selection, and customer group adaptation, supporting integrated planning of \"commercial attributes + aesthetic design.\" Suitable as a promotional image for a cafe design SaaS product, with a 16:9 aspect ratio.",
    "aspect_ratio": "1:1",
    "quality": "basic",
    "output_format": "png",
    "nsfw_checker": false
  }
}'

json

{
  "model": "seedream/5-pro-text-to-image",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A full-process cafe design tool for entrepreneurs and designers. It covers core needs including store layout, functional zoning, decoration style, equipment selection, and customer group adaptation, supporting integrated planning of \"commercial attributes + aesthetic design.\" Suitable as a promotional image for a cafe design SaaS product, with a 16:9 aspect ratio.",
    "aspect_ratio": "1:1",
    "quality": "basic",
    "output_format": "png",
    "nsfw_checker": false
  }
}

Response

200 — Request successful.

参数	类型	必填	说明
`code`	`integer`	否	Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying). 可选值：`200` / `401` / `402` / `404` / `422` / `429` / `455` / `500` / `501` / `505`。示例：`200`。
`msg`	`string`	否	Response message, error description when failed 示例：`success`。
`data`	`object`	是	—
`data.taskId`	`string`	否	Task ID, can be used with Get Task Details endpoint to query task status
`data.recordId`	`string`	否	Record ID, can be used to get the record details

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_seedream_1765166238716"
  }
}

500 — Server error.

参数	类型	必填	说明
`code`	`integer`	是	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 - 408: Timeout - No result has been returned for over 10 minutes. - 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
`msg`	`string`	是	Response message, error description when failed
`data`	`object`	是	—

json

{
  "code": 500,
  "msg": "Server Error - An unexpected error occurred while processing the request",
  "data": null
}

Callback

onImageGenerated

Callback URL: {$request.body#/callBackUrl} (the callBackUrl in the request body).

Sent when the task succeeds or fails.

Callback body parameters

参数	类型	必填	说明
`code`	`integer`	否	200: success. 501: failure; see data.failCode and data.failMsg. Allowed values：`200` / `501`。示例：`200`。
`msg`	`string`	否	Status message 示例：`Playground task completed successfully.`。
`data`	`object`	否	—
`data.completeTime`	`integer`	否	Task completion time, represented as a Unix timestamp in milliseconds 示例：`1786417135000`。
`data.costTime`	`integer`	否	Processing time in seconds. Present on both success and failure callbacks. 示例：`165`。
`data.createTime`	`integer`	否	Task creation time, represented as a Unix timestamp in milliseconds 示例：`1786416968000`。
`data.creditsConsumed`	`number`	否	Credits consumed by the task; 0 for failed tasks. 示例：`7`。
`data.model`	`string`	否	Image generation model used for the task 示例：`seedream/5-pro-text-to-image`。
`data.param`	`string`	否	Parameters submitted when creating the task, in JSON string format 示例：{"input":"{\"aspect_ratio\":\"1:1\",\"output_format\":\"png\",\"prompt\":\"A full-process cafe design toolfor entrepreneurs and designers. It covers core needs including store layout, functional zoning, decoration style, equipment selection, andcustomer group adaptation, supporting integrated planning of \\\"commercial attributes + aesthetic design.\\\" Suitable as apromotional image for a cafe design SaaS product, with a 16:9 aspect ratio.\",\"nsfw_checker\":false,\"quality\":\"basic\"}","callBackUrl":"https://your-domain.com/api/callback","model":"seedream/5-pro-text-to-image"}。
`data.resultJson`	`string`	否	Image generation result in JSON string format. resultUrls contains the list of generated image URLs. Present only when state is success. 示例：`{"resultUrls":["https://tempfile.aiquickdraw.com/p/b0e3febbf194d27a345de523d3321555_1_1786417134_1086.png"]}`。
`data.state`	`string`	否	Task status Allowed values：`success` / `fail`。示例：`success`。
`data.taskId`	`string`	否	Task ID 示例：`b0e3febbf194d27a345de523d3321555`。
`data.updateTime`	`integer`	否	Use completeTime as the completion time; updateTime may equal createTime. 示例：`1786417135000`。
`data.failCode`	`string`	否	Failure code, a numeric string such as "400" or "500". Present only when state is fail. 示例：`500`。
`data.failMsg`	`string`	否	Failure reason. Present only when state is fail. 示例：`<error detail>`。

Success

json

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "b0e3febbf194d27a345de523d3321555",
    "model": "seedream/5-pro-text-to-image",
    "state": "success",
    "param": "{\"input\":\"{\\\"aspect_ratio\\\":\\\"1:1\\\",\\\"output_format\\\":\\\"png\\\",\\\"prompt\\\":\\\"A full-process cafe design toolfor entrepreneurs and designers. It covers core needs including store layout, functional zoning, decoration style, equipment selection, andcustomer group adaptation, supporting integrated planning of \\\\\\\"commercial attributes + aesthetic design.\\\\\\\" Suitable as apromotional image for a cafe design SaaS product, with a 16:9 aspect ratio.\\\",\\\"nsfw_checker\\\":false,\\\"quality\\\":\\\"basic\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"seedream/5-pro-text-to-image\"}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/p/b0e3febbf194d27a345de523d3321555_1_1786417134_1086.png\"]}",
    "completeTime": 1786417135000,
    "createTime": 1786416968000,
    "costTime": 165,
    "creditsConsumed": 7,
    "updateTime": 1786417135000
  }
}

Failure

json

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "b0e3febbf194d27a345de523d3321555",
    "model": "seedream/5-pro-text-to-image",
    "state": "fail",
    "param": "{\"input\":\"{\\\"aspect_ratio\\\":\\\"1:1\\\",\\\"output_format\\\":\\\"png\\\",\\\"prompt\\\":\\\"A full-process cafe design toolfor entrepreneurs and designers. It covers core needs including store layout, functional zoning, decoration style, equipment selection, andcustomer group adaptation, supporting integrated planning of \\\\\\\"commercial attributes + aesthetic design.\\\\\\\" Suitable as apromotional image for a cafe design SaaS product, with a 16:9 aspect ratio.\\\",\\\"nsfw_checker\\\":false,\\\"quality\\\":\\\"basic\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"seedream/5-pro-text-to-image\"}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786417135000,
    "createTime": 1786416968000,
    "costTime": 165,
    "creditsConsumed": 0,
    "updateTime": 1786417135000
  }
}

Seedream5.0 Pro - Text to Image ​

Endpoint ​

Query Task Status ​

Related Resources ​

Request Parameters ​

Body (application/json) ​

Request Example ​

Response ​

200 — Request successful. ​

500 — Server error. ​

Callback ​

onImageGenerated ​

Seedream5.0 Pro - Text to Image

Endpoint

Query Task Status

Related Resources

Request Parameters

Body (application/json)

Request Example

Response

200 — Request successful.

500 — Server error.

Callback

onImageGenerated