Seedream3.0 - 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.

Image generation by Seedream3.0

Output format: WebP.

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

Request Parameters

Body (application/json)

Parameter	Type	Required	Description
model	string	Yes	The model name to use for generation. Required field. - Must be bytedance/seedream for this endpoint Default："bytedance/seedream"。 Allowed values：bytedance/seedream。 示例：bytedance/seedream。
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	No	Input parameters for the generation task
input.prompt	string	Yes	The text prompt used to generate the image (Max length: 5000 characters) 示例：A 2D flat art style campsite poster with the text “ModelFold AI Seedream 3.0 API”. The scene includes mountains, brown tents under a sunny sky, a rabbit, a deer, some birds, green grass, and a flowing river, all illustrated in clean vector art.。
input.image_size	string	No	Output size preset. One of square, square_hd, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9. Default："square_hd"。 Allowed values：square / square_hd / portrait_4_3 / portrait_16_9 / landscape_4_3 / landscape_16_9。 示例：square_hd。
input.guidance_scale	number	No	Controls how closely the output image aligns with the input prompt. Higher values mean stronger prompt correlation. (Min: 1, Max: 10, Step: 0.1) (step: 0.1) Default：2.5。 示例：2.5。
input.seed	integer	No	Random seed to control the stochasticity of image generation.

Request Example

curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "bytedance/seedream",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A 2D flat art style campsite poster with the text “ModelFold AI Seedream 3.0 API”. The scene includes mountains, brown tents under a sunny sky, a rabbit, a deer, some birds, green grass, and a flowing river, all illustrated in clean vector art.",
    "image_size": "square_hd",
    "guidance_scale": 2.5
  }
}'

{
  "model": "bytedance/seedream",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A 2D flat art style campsite poster with the text “ModelFold AI Seedream 3.0 API”. The scene includes mountains, brown tents under a sunny sky, a rabbit, a deer, some birds, green grass, and a flowing river, all illustrated in clean vector art.",
    "image_size": "square_hd",
    "guidance_scale": 2.5
  }
}

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 / 433 / 455 / 500 / 501 / 505。 示例：200。
msg	string	否	Response message, error description upon failure 示例：success。
data	object	是	—
data.taskId	string	是	The task ID can be used with the "Get Task Details" endpoint to query the task status. 示例：dc1928bfcbc77cb6c85f3359a9c718b3。

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

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	是	—

{
  "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 示例：1786413282000。
data.costTime	integer	否	Processing time in seconds. Present on both success and failure callbacks. 示例：21。
data.createTime	integer	否	Task creation time, represented as a Unix timestamp in milliseconds 示例：1786413258000。
data.creditsConsumed	number	否	Credits consumed by the task; 0 for failed tasks. 示例：3.5。
data.model	string	否	Image generation model used for the task 示例：bytedance/seedream。
data.param	string	否	Parameters submitted when creating the task, in JSON string format 示例：{"input":"{\"image_size\":\"square_hd\",\"guidance_scale\":\"2.5\",\"prompt\":\"A campsite poster in a 2Dflat art style featuring the text ‘ModelFold AI Seedream 3.0 API’. The scene includes mountains, a brown tent beneath a clear sky, a rabbit, a deer,several small birds, green grass, and a flowing stream, all presented in a clean vector illustration style.\"}","callBackUrl":"https://your-domain.com/api/callback","model":"bytedance/seedream"}。
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/558a0e58d58a6cb69e5c6a55170398da_1_1786413281_4092.jpg"]}。
data.state	string	否	Task status Allowed values：success / fail。 示例：success。
data.taskId	string	否	Task ID 示例：558a0e58d58a6cb69e5c6a55170398da。
data.updateTime	integer	否	Use completeTime as the completion time; updateTime may equal createTime. 示例：1786413282000。
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

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "558a0e58d58a6cb69e5c6a55170398da",
    "model": "bytedance/seedream",
    "state": "success",
    "param": "{\"input\":\"{\\\"image_size\\\":\\\"square_hd\\\",\\\"guidance_scale\\\":\\\"2.5\\\",\\\"prompt\\\":\\\"A campsite poster in a 2Dflat art style featuring the text ‘ModelFold AI Seedream 3.0 API’. The scene includes mountains, a brown tent beneath a clear sky, a rabbit, a deer,several small birds, green grass, and a flowing stream, all presented in a clean vector illustration style.\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"bytedance/seedream\"}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/p/558a0e58d58a6cb69e5c6a55170398da_1_1786413281_4092.jpg\"]}",
    "completeTime": 1786413282000,
    "createTime": 1786413258000,
    "costTime": 21,
    "creditsConsumed": 3.5,
    "updateTime": 1786413282000
  }
}

Failure

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "558a0e58d58a6cb69e5c6a55170398da",
    "model": "bytedance/seedream",
    "state": "fail",
    "param": "{\"input\":\"{\\\"image_size\\\":\\\"square_hd\\\",\\\"guidance_scale\\\":\\\"2.5\\\",\\\"prompt\\\":\\\"A campsite poster in a 2Dflat art style featuring the text ‘ModelFold AI Seedream 3.0 API’. The scene includes mountains, a brown tent beneath a clear sky, a rabbit, a deer,several small birds, green grass, and a flowing stream, all presented in a clean vector illustration style.\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"bytedance/seedream\"}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786413282000,
    "createTime": 1786413258000,
    "costTime": 21,
    "creditsConsumed": 0,
    "updateTime": 1786413282000
  }
}