Skip to content
中文
Get API key
☰

Seedream 5.5 API documentation

Integrate Seedream 5.5 with your VezAPI key. The operations below share the same authentication and account balance.

Base URL: https://api.vezapi.com
Send Authorization: Bearer YOUR_VEZAPI_KEY. Use a unique Idempotency-Key for each submission; reuse it only when checking the same request.

Seedream5.5 文生图

POST/api/v1/jobs/createTask

Model IDs: seedream/5-5-text-to-image

ParameterTypeDescription & constraints
model
required		string

用于生成的模型名称。必填字段。 - 此端点必须使用 `seedream/5-5-text-to-image`

Values: "seedream/5-5-text-to-image"

Default: "seedream/5-5-text-to-image"

callBackUrl
optional		string

接收生成任务完成更新的 URL。可选但建议在生产环境中使用。 - 当生成完成时，系统将向此 URL POST 任务状态和结果 - 回调包含生成的内容 URL 和任务信息 - 您的回调端点应接受包含结果的 JSON 负载的 POST 请求 - 或者，使用获取任务详情端点轮询任务状态 - 为确保回调安全性，请参阅 [Webhook 校验指南](/cn/common-api/webhook-verification) 了解签名验证实现方法

input
required		object

生成任务的输入参数

input.prompt
required		string

必填。文本提示词，5–5000 字符。

minLength: 5

maxLength: 5000

input.aspect_ratio
required		string

必填。输出图像的宽高比。

Values: "1:1", "4:3", "3:4", "16:9", "9:16", "2:3", "3:2", "21:9"

input.size
optional		string

输出图像的清晰度档位，影响积分消耗。默认 `2K`。

Values: "1K", "1.5K", "2K"

Default: "2K"

input.output_format
optional		string

输出图像格式。默认 `png`。

Values: "png", "jpeg"

Default: "png"

input.background
optional		string

输出图像的背景。默认 `auto`。 - `auto`：由模型决定 - `transparent`：透明背景 - `opaque`：不透明背景 `transparent` 仅在 `output_format` 为 `png` 时可用。

Values: "auto", "transparent", "opaque"

Default: "auto"

input.nsfw_checker
optional		boolean

默认 false。为 false 时不额外进行内容过滤，结果由模型直接返回。

Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "seedream/5-5-text-to-image",
  "input": {
    "prompt": "高端护肤品电商主图，纯白柔光展台，玻璃精华瓶，商业写实摄影",
    "aspect_ratio": "1:1"
  }
}'
Responses and errors

HTTP 200

ParameterTypeDescription & constraints
code
optional		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).

Values: 200, 401, 402, 404, 422, 429, 455, 500, 501, 505

msg
optional		string

Response message, error description when failed

data
required		object
data.taskId
optional		string

Task ID, can be used with Get Task Details endpoint to query task status

data.recordId
optional		string

Record ID, can be used to get the record details

HTTP 500

Server error.

ParameterTypeDescription & constraints
code
required		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
required		string

Response message, error description when failed

data
required		object

Seedream5.5 图层分离

POST/api/v1/jobs/createTask

Model IDs: seedream/5-5-layer-decomposition

ParameterTypeDescription & constraints
model
required		string

用于执行图层分离任务的模型名称。必填字段。 - 此端点必须使用 `seedream/5-5-layer-decomposition`

Values: "seedream/5-5-layer-decomposition"

Default: "seedream/5-5-layer-decomposition"

callBackUrl
optional		string

接收任务完成通知的回调 URL。可选，但建议在生产环境中使用。 - 任务完成后，系统将向此 URL 发送 POST 请求 - 回调内容包含任务状态、生成结果 URL 和任务信息 - 也可以通过获取任务详情接口主动查询任务状态 - 回调签名校验方式请参考 [Webhook 校验指南](/cn/common-api/webhook-verification)

input
required		object

图层分离任务的输入参数

input.image_url
required		string

必填。待分离图片的 URL。 - 只能传 1 张，须为公网可访问地址 - 支持格式：JPEG、PNG、WEBP - 不超过 10 MB

input.prompt
optional		string

可选。描述要拆出的元素，0–2000 字符。 - 传入时，模型按描述分离指定元素 - 留空时，模型自动识别图片中的主要元素 - 可用 `<bbox>x1 y1 x2 y2</bbox>` 标注元素位置，坐标按 0–1000 归一化

minLength: 0

maxLength: 2000

input.size
optional		string

输出图片的清晰度档位。默认 `auto`。 - `auto`：保持原图尺寸（小于 1K 提升到 1K，大于 2K 压缩到 2K），按 2K 档计费 - `1K` / `1.5K` / `2K`：固定清晰度档位

Values: "auto", "1K", "1.5K", "2K"

Default: "auto"

input.output_format
optional		string

底图的输出格式。默认 `png`。仅影响底图，分离出的图层固定为 PNG（透明背景）。

Values: "png", "jpeg"

Default: "png"

input.max_images
optional		integer

最多输出的图片张数（含 1 张底图）。范围 2–100，默认 30。按实际拆出的张数计费。

Default: 30

minimum: 2

maximum: 100

input.text_recognition
optional		boolean

是否识别图层中的文字。默认 `false`。

Default: false

input.nsfw_checker
optional		boolean

默认 false。为 false 时不额外进行内容过滤，结果由模型直接返回。

Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "seedream/5-5-layer-decomposition",
  "input": {
    "image_url": "https://example.com/input.png",
    "prompt": "将标题文字 <bbox>179 58 809 197</bbox> 和鹦鹉 <bbox>330 274 641 991</bbox> 分离为独立图层"
  }
}'
Responses and errors

HTTP 200

ParameterTypeDescription & constraints
code
optional		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).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional		string

Response message, error description upon failure

data
required		object
data.taskId
required		string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

HTTP 500

Server error.

ParameterTypeDescription & constraints
code
required		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
required		string

Response message, error description when failed

data
required		object

Seedream5.5 - Image to Image

POST/api/v1/jobs/createTask

Model IDs: seedream/5-5-image-to-image

ParameterTypeDescription & constraints
model
required		string

The model name to use for generation. Required field. - Must be `seedream/5-5-image-to-image` for this endpoint

Values: "seedream/5-5-image-to-image"

Default: "seedream/5-5-image-to-image"

callBackUrl
optional		string

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

input
required		object

Input parameters for the generation task

input.prompt
required		string

Required. Editing instruction, 5–5000 characters.

minLength: 5

maxLength: 5000

input.image_urls
required		array

Required. Input image URLs (publicly accessible URLs, not file content). - 1–10 images - Supported formats: JPEG, PNG, WEBP - Max 10 MB per image - Each input image is billed separately; see [VezAPI.ai/pricing]([see VezAPI documentation])

minItems: 1

maxItems: 10

input.aspect_ratio
optional		string

Required. Aspect ratio of the output image.

Values: "1:1", "4:3", "3:4", "16:9", "9:16", "2:3", "3:2", "21:9", "auto"

Default: "auto"

input.size
optional		string

Resolution tier of the output image. Affects the credit cost. Defaults to `2K`.

Values: "1K", "1.5K", "2K"

Default: "2K"

input.output_format
optional		string

Output image format. Defaults to `png`.

Values: "png", "jpeg"

Default: "png"

input.background
optional		string

Background of the output image. Defaults to `auto`. - `auto`: decided by the model - `transparent`: transparent background - `opaque`: opaque background `transparent` is available only when `output_format` is `png`.

Values: "auto", "transparent", "opaque"

Default: "auto"

input.nsfw_checker
optional		boolean

Defaults to false. When false, no additional content filtering is applied and results are returned directly by the model.

Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "seedream/5-5-image-to-image",
  "input": {
    "prompt": "Keep the model'\''s pose and the flowing shape of the liquid dress unchanged. Change the clothing material from silver metal to completely transparent clear water (or glass). Through the liquid water, the model'\''s skin details are visible. Lighting changes from reflection to refraction.",
    "image_urls": [
      "https://example.com/input.png"
    ],
    "aspect_ratio": "auto"
  }
}'
Responses and errors

HTTP 200

Request successful.

ParameterTypeDescription & constraints
code
optional		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).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional		string

Response message, error description upon failure

data
required		object
data.taskId
required		string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

HTTP 500

Server error.

ParameterTypeDescription & constraints
code
required		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
required		string

Response message, error description when failed

data
required		object

Task status and callbacks

For asynchronous tasks, keep the returned taskId. Query GET /api/v1/jobs/recordInfo?taskId=... or provide callBackUrl when creating the task. Only the account that created a task can access it or derive new resources from it.

A timeout can mean the submission was accepted. Inspect the existing request in your dashboard; do not create another task automatically. Callback delivery is retried and may arrive more than once. Deduplicate with X-VezAPI-Event-Id.

Files, logs and billing

Generated media normally follows a 14-day provider lifetime; uploaded files expire after 24 hours. Save the files you need before expiration. VezAPI streams registered files without keeping a permanent media library. Request logs are retained for two calendar months.

Credits are reserved before submission. Final deductions match actual discounted consumption one for one. Unknown usage pauses new paid requests. If available funds cannot cover final usage while protecting other reservations, settlement stays pending until funded; model usage cannot make the wallet negative. Time-based inputs require server-side metadata reads; a failed read prevents submission.