Seedream 5.0 Pro API documentation
Integrate Seedream 5.0 Pro with your VezAPI key. The operations below share the same authentication and account balance.
https://api.vezapi.comSend Authorization: Bearer YOUR_VEZAPI_KEY. Use a unique Idempotency-Key for each submission; reuse it only when checking the same request.
Seedream5.0 Pro - Image to Image
/api/v1/jobs/createTaskModel IDs: seedream/5-pro-image-to-image
| Parameter | Type | Description & constraints |
|---|---|---|
modelrequired | string | The model name to use for generation. Required field. - Must be `seedream/5-pro-image-to-image` for this endpoint Values: Default: |
callBackUrloptional | 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 |
inputrequired | object | Input parameters for the generation task |
input.promptrequired | string | Text prompt, 4–5000 characters.
|
input.image_urlsrequired | array | Upload an image file to use as input for the API (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 30.0MB)
|
input.aspect_ratiorequired | string | Required. Width-height ratio of the image, determining its visual form. Values: |
input.qualityrequired | string | Required. Basic outputs 1K images, while High outputs 2K images. Values: |
input.output_formatoptional | string | Format of the output image Values: Default: |
input.nsfw_checkeroptional | 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-pro-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": "1:1",
"quality": "basic"
}
}'Responses and errors
HTTP 200
Request successful.
| Parameter | Type | Description & constraints |
|---|---|---|
codeoptional | 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: |
msgoptional | string | Response message, error description upon failure |
datarequired | object | |
data.taskIdrequired | string | The task ID can be used with the "Get Task Details" endpoint to query the task status. |
HTTP 500
Server error.
| Parameter | Type | Description & constraints |
|---|---|---|
coderequired | 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 |
msgrequired | string | Response message, error description when failed |
datarequired | object |
Seedream5.0 Pro - Text to Image
/api/v1/jobs/createTaskModel IDs: seedream/5-pro-text-to-image
| Parameter | Type | Description & constraints |
|---|---|---|
modelrequired | string | The model name to use for generation. Required field. - Must be `seedream/5-pro-text-to-image` for this endpoint Values: Default: |
callBackUrloptional | 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 |
inputrequired | object | Input parameters for the generation task |
input.promptrequired | string | Text prompt, 4–5000 characters.
|
input.aspect_ratiorequired | string | Required. Width-height ratio of the image, determining its visual form. Values: |
input.qualityrequired | string | Required. Basic outputs 1K images, while High outputs 2K images. Values: |
input.output_formatoptional | string | Format of the output image Values: Default: |
input.nsfw_checkeroptional | 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-pro-text-to-image",
"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"
}
}'Responses and errors
HTTP 200
Request successful.
| Parameter | Type | Description & constraints |
|---|---|---|
codeoptional | 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: |
msgoptional | string | Response message, error description when failed |
datarequired | object | |
data.taskIdoptional | string | Task ID, can be used with Get Task Details endpoint to query task status |
data.recordIdoptional | string | Record ID, can be used to get the record details |
HTTP 500
Server error.
| Parameter | Type | Description & constraints |
|---|---|---|
coderequired | 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 |
msgrequired | string | Response message, error description when failed |
datarequired | 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.