Seedream4.0 - Edit

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 editing by Seedream4.0

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 `bytedance/seedream-v4-edit` for this endpoint Default：`"bytedance/seedream-v4-edit"`。 Allowed values：`bytedance/seedream-v4-edit`。示例：`bytedance/seedream-v4-edit`。
`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 edit the image (Max length: 5000 characters) 示例：`Refer to this logo and create a single visual showcase for an outdoor sports brand named ‘ModelFold AI’. Display five branded items together in one image: a packaging bag, a hat, a carton box, a wristband, and a lanyard. Use blue as the main visual color, with a fun, simple, and modern style.`。
`input.image_urls`	`array<string>`	Yes	List of URLs of input images for editing. Presently, up to 10 image inputs are allowed. (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 30.0MB)
`input.image_size`	`string`	No	The size of the generated image. Default：`"square_hd"`。 Allowed values：`square` / `square_hd` / `portrait_4_3` / `portrait_3_2` / `portrait_16_9` / `landscape_4_3` / `landscape_3_2` / `landscape_16_9` / `landscape_21_9`。示例：`square_hd`。
`input.image_resolution`	`string`	No	Final image resolution is determined by combining image_size (aspect ratio) and image_resolution (pixel scale).. Default：`"1K"`。 Allowed values：`1K` / `2K` / `4K`。示例：`1K`。
`input.max_images`	`number`	No	Set this value (1–6) to cap how many images a single generation run can produce in one set—because they’re created in one shot rather than separate requests, you must also state the exact number you want in the prompt so both settings align. (Min: 1, Max: 6, Step: 1) (step: 1) Default：`1`。示例：`1`。
`input.seed`	`integer`	No	Random seed for reproducible results. Integer, up to 1000000. Omit for a random seed.
`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": "bytedance/seedream-v4-edit",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "Refer to this logo and create a single visual showcase for an outdoor sports brand named ‘ModelFold AI’. Display five branded items together in one image: a packaging bag, a hat, a carton box, a wristband, and a lanyard. Use blue as the main visual color, with a fun, simple, and modern style.",
    "image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png"
    ],
    "image_size": "square_hd",
    "image_resolution": "1K",
    "max_images": 1,
    "seed": 42,
    "nsfw_checker": true
  }
}'

json

{
  "model": "bytedance/seedream-v4-edit",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "Refer to this logo and create a single visual showcase for an outdoor sports brand named ‘ModelFold AI’. Display five branded items together in one image: a packaging bag, a hat, a carton box, a wristband, and a lanyard. Use blue as the main visual color, with a fun, simple, and modern style.",
    "image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png"
    ],
    "image_size": "square_hd",
    "image_resolution": "1K",
    "max_images": 1,
    "seed": 42,
    "nsfw_checker": true
  }
}

Response

200 — Request successful

json

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

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 示例：`1786414494000`。
`data.costTime`	`integer`	否	Processing time in seconds. Present on both success and failure callbacks. 示例：`33`。
`data.createTime`	`integer`	否	Task creation time, represented as a Unix timestamp in milliseconds 示例：`1786414456000`。
`data.creditsConsumed`	`number`	否	Credits consumed by the task; 0 for failed tasks. 示例：`5`。
`data.model`	`string`	否	Image editing model used for the task 示例：`bytedance/seedream-v4-edit`。
`data.param`	`string`	否	Parameters submitted when creating the task, in JSON string format 示例：{"input":"{\"seed\":900000,\"image_size\":\"square_hd\",\"image_resolution\":\"1K\",\"image_urls\":[\"https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png\"],\"max_images\":1,\"prompt\":\"Create avisual presentation for the outdoor sports brand ‘ModelFold AI’ based on this logo. Present five branded merchandise products in the same image: apackaging bag, a hat, a cardboard box, a wristband, and a lanyard. Use blue as the primary visual color, with a lively, minimalist, and modernstyle.\",\"nsfw_checker\":false}","callBackUrl":"https://your-domain.com/api/callback","model":"bytedance/seedream-v4-edit"}。
`data.resultJson`	`string`	否	Image generation result in JSON string format. resultUrls contains a list of generated image URLs. Present only when state is success. 示例：`{"resultUrls":["https://tempfile.aiquickdraw.com/p/e5790bfbeb0009d0eb4a546513bd8865_1_1786414493_4712.jpg"]}`。
`data.state`	`string`	否	Task status Allowed values：`success` / `fail`。示例：`success`。
`data.taskId`	`string`	否	Task ID 示例：`e5790bfbeb0009d0eb4a546513bd8865`。
`data.updateTime`	`integer`	否	Use completeTime as the completion time; updateTime may equal createTime. 示例：`1786414494000`。
`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": "e5790bfbeb0009d0eb4a546513bd8865",
    "model": "bytedance/seedream-v4-edit",
    "state": "success",
    "param": "{\"input\":\"{\\\"seed\\\":900000,\\\"image_size\\\":\\\"square_hd\\\",\\\"image_resolution\\\":\\\"1K\\\",\\\"image_urls\\\":[\\\"https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png\\\"],\\\"max_images\\\":1,\\\"prompt\\\":\\\"Create avisual presentation for the outdoor sports brand ‘ModelFold AI’ based on this logo. Present five branded merchandise products in the same image: apackaging bag, a hat, a cardboard box, a wristband, and a lanyard. Use blue as the primary visual color, with a lively, minimalist, and modernstyle.\\\",\\\"nsfw_checker\\\":false}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"bytedance/seedream-v4-edit\"}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/p/e5790bfbeb0009d0eb4a546513bd8865_1_1786414493_4712.jpg\"]}",
    "completeTime": 1786414494000,
    "createTime": 1786414456000,
    "costTime": 33,
    "creditsConsumed": 5,
    "updateTime": 1786414494000
  }
}

Failure

json

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "e5790bfbeb0009d0eb4a546513bd8865",
    "model": "bytedance/seedream-v4-edit",
    "state": "fail",
    "param": "{\"input\":\"{\\\"seed\\\":900000,\\\"image_size\\\":\\\"square_hd\\\",\\\"image_resolution\\\":\\\"1K\\\",\\\"image_urls\\\":[\\\"https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png\\\"],\\\"max_images\\\":1,\\\"prompt\\\":\\\"Create avisual presentation for the outdoor sports brand ‘ModelFold AI’ based on this logo. Present five branded merchandise products in the same image: apackaging bag, a hat, a cardboard box, a wristband, and a lanyard. Use blue as the primary visual color, with a lively, minimalist, and modernstyle.\\\",\\\"nsfw_checker\\\":false}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"bytedance/seedream-v4-edit\"}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786414494000,
    "createTime": 1786414456000,
    "costTime": 33,
    "creditsConsumed": 0,
    "updateTime": 1786414494000
  }
}

Seedream4.0 - Edit ​

Endpoint ​

Query Task Status ​

Related Resources ​

Request Parameters ​

Body (application/json) ​

Request Example ​

Response ​

200 — Request successful ​

500 — Server error. ​

Callback ​

onImageGenerated ​

Seedream4.0 - Edit

Endpoint

Query Task Status

Related Resources

Request Parameters

Body (application/json)

Request Example

Response

200 — Request successful

500 — Server error.

Callback

onImageGenerated