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 three-step async flow: submit to get task_id, poll status, then fetch results when status is SUCCEEDED.

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. Poll Status

Poll with task_id. Response contains only status.

POST/v1/task/query-status

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

3. Get Result

Fetch output when the task succeeds.

POST/v1/task/get-result

curl --connect-timeout 10 --max-time 60 \
  -X POST "https://api.icreat.ai/v1/task/get-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

watermarkboolean

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

output_formatstringrequired

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

Poll Status — Input

Total: 1 Required: 1 Optional: 0

task_idstringrequired

Task ID from the submit endpoint.

Get Result — Input

Total: 1 Required: 1 Optional: 0

task_idstringrequired

Task ID from the submit endpoint.

Output Schema

Submit Task — Output

Total: 1

task_idstring

Async task identifier.

Poll Status — Output

Total: 1

statusstring

Current task status. Fetch results when SUCCEEDED.

Get Result — Output

Top-level array of resource objects.

Total: 3

typestring

Resource type; Image for this model.

urlstring

Preview/access URL.

download_urlstring

Download URL.

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 three-step async task API: submit a generation request, poll status, then fetch the image URL on success.

## API Info

- **Base URL**：`https://api.icreat.ai`
- **Submit endpoint (POST)**：`/v1/task/submit/seedream-5.0-pro/edit`
- **Poll endpoint (POST)**：`/v1/task/query-status`
- **Get result endpoint (POST)**：`/v1/task/get-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. **Poll**: POST `/v1/task/query-status` with `{ "task_id": "..." }`; response contains **only** `{ "status": "SUBMITTED|SUCCEEDED|FAILED" }`
3. **Get result**: when `status` is `SUCCEEDED`, POST `/v1/task/get-result`; top-level array; read `url` or `download_url` when `type` is `Image`

### Input Notes

- Request body uses top-level flat fields
- Required: `prompt`, `size`, `output_format`
- Optional: `image`, `watermark`
- `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` (optional): 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` only
- Result: top-level `[{ "type": "Image", "url": "...", "download_url": "..." }]`

## Notes

- Use the same `task_id` across all three steps; do not skip polling
- `FAILED` is terminal — check request parameters or reference media