Skip to main content
POST

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json
prompt
string
required

Describe the desired image. Required, with up to 10000 characters. Keep the instructions focused and describe the aspect ratio in the prompt.

Required string length: 1 - 10000
Pattern: \S
Example:

"A detailed landscape in a 16:9 composition"

size
enum<string>
default:2K

Output resolution preset. Describe the aspect ratio in the prompt. Custom dimensions, auto, and 4K are rejected.

Available options:
1K,
1.5K,
2K
output_format
enum<string>
default:png

Output file format. Transparent backgrounds require PNG.

Available options:
png,
jpeg
background
enum<string>
default:auto

Generation background mode. transparent produces RGBA and requires PNG.

Available options:
auto,
transparent,
opaque
optimize_prompt_mode
enum<string>
default:standard

Prompt optimization mode. Seedream 5.5 supports standard only.

Available options:
standard
safety_identifier
string

Optional stable English identifier for the end user. Prefer a hash instead of personal information. The upstream value is preserved in the completed result.

Required string length: 1 - 64
Pattern: ^[\x20-\x7E]+$

Response

Task submitted successfully

code
integer
required

Response code, 0 indicates success

Example:

0

message
string
required

Response message

Example:

"success"

data
object
required

Detailed data about the submitted asynchronous task.