seedream-5.0-pro/edit

Base URL

https://api.icreat.ai

Authentication

All API requests must be authenticated with an API Key. You can obtain an API Key from the console.

export ICREAT_API_KEY="your-api-key-here"

HTTP Request Headers

import os

API_KEY = os.environ.get("ICREAT_API_KEY")
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer " + API_KEY,
}

Protect your API Key

Never expose your API Key in client-side code or public repositories. Use environment variables or a backend proxy.

Code Examples

Image and video generation uses a two-step async flow: submit a task to get task_id, then poll via query task result; the response includes status and result ([] while processing; on SUCCEEDED, result holds resources and costUSD is present). The examples below use the same task_id across both steps.

1. Submit Task

Send a generation request to the submit endpoint.

POST/v1/task/submit/seedream-5.0-pro/edit

curl --fail-with-body --connect-timeout 10 --max-time 60 \
  -X POST "https://api.icreat.ai/v1/task/submit/seedream-5.0-pro/edit" \
  -H "Authorization: Bearer ${ICREAT_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "image": [
      "https://upload.icreat.ai/upload/xxx.png"
    ],
    "prompt": "An eagle flying",
    "size": "2K",
    "watermark": false,
    "output_format": "png"
  }'

2. Query Task Result (Poll)

Use the task_id from submit to poll progress (repeat until terminal). The response includes status and result: result is [] while processing; on SUCCEEDED, result holds resources and costUSD is included; FAILED means the task failed.

POST/v1/task/result

curl --fail-with-body --connect-timeout 10 --max-time 60 \
  -X POST "https://api.icreat.ai/v1/task/result" \
  -H "Authorization: Bearer ${ICREAT_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"task_id": "task-xxx"}'

Input Schema

Submit Task — Input

Total: 5 Required: 3 Optional: 2

imagestring[]

List of reference image URLs. Up to 10 images can be uploaded. Supports common image formats, with a maximum of 30 MB per image.

promptstringrequired

Image generation prompt, up to 10,000 characters.

sizestringrequired

Output image resolution. Available values: 2048x2048, 2304x1728, 1728x2304, 2496x1664, 1664x2496, 2720x1530, 1530x2720

watermarkbooleanrequired

Whether to add a watermark to the generated result. Default value: true

output_formatstringrequired

Output image format. Available values: png, jpg. Default value: png

Query Task Result — Input

Total: 1 Required: 1 Optional: 0

task_idstringrequired

The task ID returned from the submit endpoint.

Output Schema

Submit Task — Output

Total: 1

task_idstring

Async task identifier.

Query Task Result — Output

Total: variable

statusstring

Current task status. result is usually [] until success; on SUCCEEDED, result holds resources and costUSD is present.

SUBMITTEDSUCCEEDEDFAILED

resultarray[object]

Generated resources. Empty array while processing or on failure; array of objects on success.

costUSDnumber

Task cost in USD. Present only when status is SUCCEEDED.

LLM Prompt

The Markdown below is an LLM-friendly prompt you can paste into AI assistants (e.g. Cursor, ChatGPT) to help them understand this model's API, call flow, and key parameters. Use Copy for AI or copy from the code block below.

# seedream-5.0-pro/edit

> seedream-5.0-pro/edit

## Overview

Use the iCreat two-step async task API: submit a generation request, then poll the query task result endpoint; on success read resources from `result` (includes `costUSD`).

## API Info

- **Base URL**：`https://api.icreat.ai`
- **Submit endpoint (POST)**：`/v1/task/submit/seedream-5.0-pro/edit`
- **Query result endpoint (POST)**：`/v1/task/result`
- **Model ID**：`seedream-5.0-pro/edit`
- **Auth**：`Authorization: Bearer ${ICREAT_API_KEY}`

## Call Flow

1. **Submit**: POST submit path with body per Input Notes; response `{ "task_id": "..." }`
2. **Query result**: POST `/v1/task/result` with `{ "task_id": "..." }`; response includes `status` and `result` (`[]` while processing); on `SUCCEEDED`, `result` holds resources and `costUSD` is present; read `url` or `download_url` when `type` is `Image`

### Input Notes

- Request body uses top-level flat fields
- Required: `prompt`, `size`, `watermark`, `output_format`
- Optional: `image`
- `image` (optional): List of reference image URLs. Up to 10 images can be uploaded. Supports common image formats, with a maximum of 30 MB per image.
- `prompt` (required): Image generation prompt, up to 10,000 characters.
- `size` (required): Output image resolution. Available values: `2048x2048`, `2304x1728`, `1728x2304`, `2496x1664`, `1664x2496`, `2720x1530`, `1530x2720`
- `watermark` (required): Whether to add a watermark to the generated result. Default value: `true`
- `output_format` (required): Output image format. Available values: `png`, `jpg`. Default value: `png`

### Output Notes

- Poll: read `status`; `result` is `[]` while processing
- Success: `result` is `[{ "type": "Image", "url": "...", "download_url": "..." }]` plus `costUSD`

## Notes

- Use the same `task_id` across both steps; `result` is `[]` while processing — keep polling
- `FAILED` is terminal — check request parameters or reference media