# Seedream4.0 - Edit
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Seedream4.0 - Edit
deprecated: false
description: >
Image editing by Seedream4.0
## Query Task Status
After submitting a task, use the unified query endpoint to check
progress and retrieve results:
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
Explore all available models
Check credits and account usage
operationId: bytedance-seedream-v4-edit
tags:
- docs/en/Market/Image Models/Seedream
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
properties:
model:
type: string
enum:
- bytedance/seedream-v4-edit
default: bytedance/seedream-v4-edit
description: |-
The model name to use for generation. Required field.
- Must be `bytedance/seedream-v4-edit` for this endpoint
examples:
- bytedance/seedream-v4-edit
callBackUrl:
type: string
format: uri
description: >-
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](/common-api/webhook-verification) for signature
verification implementation
examples:
- https://your-domain.com/api/callback
input:
type: object
description: Input parameters for the generation task
properties:
prompt:
description: >-
The text prompt used to edit the image (Max length: 5000
characters)
type: string
maxLength: 5000
examples:
- >-
Refer to this logo and create a single visual showcase
for an outdoor sports brand named ‘KIE 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:
description: >-
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: 10.0MB)
type: array
items:
type: string
format: uri
maxItems: 10
examples:
- - >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png
image_size:
description: 'The size of the generated image. '
type: string
enum:
- square
- square_hd
- portrait_4_3
- portrait_3_2
- portrait_16_9
- landscape_4_3
- landscape_3_2
- landscape_16_9
- landscape_21_9
default: square_hd
examples:
- square_hd
image_resolution:
description: >-
Final image resolution is determined by combining
image_size (aspect ratio) and image_resolution (pixel
scale). For example, choosing 4:3 + 4K gives 4096 ×
3072px
type: string
enum:
- 1K
- 2K
- 4K
default: 1K
examples:
- 1K
max_images:
description: >-
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)
type: number
minimum: 1
maximum: 6
default: 1
examples:
- 1
seed:
description: >-
Random seed to control the stochasticity of image
generation.
type: integer
nsfw_checker:
type: boolean
description: >-
Defaults to false. You can set it to false based on your
needs. If set to false, our content filtering will be
disabled, and all results will be returned directly by
the model itself.
Note: There is no guarantee that everything can be
filtered out; if you are not satisfied with the results,
you will need to make your own arrangements.
required:
- prompt
- image_urls
x-apidog-orders:
- prompt
- image_urls
- image_size
- image_resolution
- max_images
- seed
- 01KWKKBVR7D6T2Z43EZTXTYWKX
x-apidog-refs:
01KWKKBVR7D6T2Z43EZTXTYWKX:
$ref: '#/components/schemas/nsfw_checker'
x-apidog-ignore-properties:
- nsfw_checker
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
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 ‘KIE 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: 80960659
nsfw_checker: true
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_bytedance_1765176680149
headers: {}
x-apidog-name: ''
'500':
description: request failed
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: >-
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**: Upstream is currently experiencing service
issues. 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:
type: string
description: Response message, error description when failed
data:
type: object
properties: {}
x-apidog-orders: []
x-apidog-ignore-properties: []
x-apidog-orders:
- code
- msg
- data
required:
- code
- msg
- data
x-apidog-ignore-properties: []
example:
code: 500
msg: >-
Server Error - An unexpected error occurred while processing
the request
data: null
headers: {}
x-apidog-name: 'Error '
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
callbacks:
onImageGenerated:
'{$request.body#/callBackUrl}':
post:
summary: Image Generation Callback
description: >-
When the image generation task is completed, the system sends
the result to the callback URL you provided via a POST request.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: >-
Status code
- **200**: Success - Image generation task completed
successfully
- **400**: Invalid request parameters or
contentviolates policy
- **500**: Internal error. Please try again later.
- **501**: Failed - Image generation task failed
enum:
- 200
- 400
- 500
- 501
msg:
type: string
description: Status message
example: Playground task completed successfully.
data:
type: object
properties:
completeTime:
type: integer
format: int64
description: >-
Task completion time, represented as a Unix
timestamp in milliseconds
example: 1786414494000
costTime:
type: integer
description: Task duration in seconds
example: 33
createTime:
type: integer
format: int64
description: >-
Task creation time, represented as a Unix
timestamp in milliseconds
example: 1786414456000
creditsConsumed:
type: number
format: double
description: Number of credits consumed by the task
example: 5
model:
type: string
description: Image editing model used for the task
example: bytedance/seedream-v4-edit
param:
type: string
description: >-
Parameters submitted when creating the task, in
JSON string format
example: >-
{"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 ‘KIE 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://webhook.uutool.cn/5f723555-ec59-4b8f-8feb-bed810982785","model":"bytedance/seedream-v4-edit"}
resultJson:
type: string
description: >-
Image generation result in JSON string format.
resultUrls contains a list of generated image
URLs.
example: >-
{"resultUrls":["https://tempfile.aiquickdraw.com/p/e5790bfbeb0009d0eb4a546513bd8865_1_1786414493_4712.jpg"]}
state:
type: string
description: Task status
enum:
- success
- fail
example: success
taskId:
type: string
description: Task ID
example: e5790bfbeb0009d0eb4a546513bd8865
updateTime:
type: integer
format: int64
description: >-
Last update time of the task, represented as a
Unix timestamp in milliseconds
example: 1786414494000
responses:
'200':
description: Callback received successfully
x-apidog-folder: docs/en/Market/Image Models/Seedream
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506354-run
components:
schemas:
nsfw_checker:
type: object
properties:
nsfw_checker:
type: boolean
description: >-
Defaults to false. You can set it to false based on your needs. If
set to false, our content filtering will be disabled, and all
results will be returned directly by the model itself.
Note: There is no guarantee that everything can be filtered out; if
you are not satisfied with the results, you will need to make your
own arrangements.
x-apidog-orders:
- nsfw_checker
x-apidog-ignore-properties: []
x-apidog-folder: ''
ApiResponse:
type: object
properties:
code:
type: integer
description: >-
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
- **422**: Validation Error - The request parameters failed
validation checks
- **429**: Rate Limited - Request limit has been exceeded for this
resource
- **433**: Request Limit - Sub-key Usage Exceeds Limit
- **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
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 433
- 455
- 500
- 501
- 505
x-apidog-enum:
- value: 200
name: ''
description: ''
- value: 401
name: ''
description: ''
- value: 402
name: ''
description: ''
- value: 404
name: ''
description: ''
- value: 422
name: ''
description: ''
- value: 429
name: ''
description: ''
- value: 433
name: ''
description: ''
- value: 455
name: ''
description: ''
- value: 500
name: ''
description: ''
- value: 501
name: ''
description: ''
- value: 505
name: ''
description: ''
msg:
type: string
description: Response message, error description when failed
examples:
- success
data:
type: object
properties:
taskId:
type: string
description: >-
Task ID, can be used with Get Task Details endpoint to query
task status
x-apidog-orders:
- taskId
required:
- taskId
x-apidog-ignore-properties: []
x-apidog-orders:
- code
- msg
- data
title: response not with recordId
required:
- data
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
BearerAuth:
type: bearer
scheme: bearer
bearerFormat: API Key
description: >-
All API requests require a Bearer Token. Add the header `Authorization:
Bearer YOUR_API_KEY` to authenticate requests.
BearerAuth1:
type: bearer
scheme: bearer
bearerFormat: API Key
description: >-
所有 API 请求都需要 Bearer Token。请在请求头中添加 `Authorization: Bearer YOUR_API_KEY`
进行身份验证。
servers:
- url: https://api.kie.ai
description: 正式环境
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
```