Skip to main content
POST
/
v1
/
images
/
edits
cURL
curl -s 'https://api.deerapi.com/v1/images/edits' \
  -H "Authorization: Bearer $DEERAPI_KEY" \
  -F 'prompt=Put on glasses' \
  -F 'model=bytedance-seedEdit-3.0-i2i' \
  -F 'response_format=json' \
  -F 'image=@/path/to/image.png'
{
  "model": "<string>",
  "created": 123,
  "data": [
    {
      "url": "<string>"
    }
  ],
  "usage": {
    "generated_images": 123,
    "output_tokens": 123,
    "total_tokens": 123
  }
}

​
Overview

Use this endpoint to call the Seedream Seededit workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.

​
Before you start

Use the DeerAPI base URL and pass your API Key in the Authorization header: 
https://api.deerapi.com

Authorization: Bearer $DEERAPI_KEY

​
Model selection

Choose a current model ID from the live pricing page. Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.

​
Implementation notes

  • Use the OpenAPI playground for the exact request fields accepted by this endpoint.
  • Keep API Keys on the server side when you build production applications.
  • Log the request ID from failed calls so support can investigate the request.
  • Retry 429, 500, and 503 responses with exponential backoff.

Authorizations

​
Authorization
string
header
required

Use a DeerAPI API Key as a Bearer token.

Body

multipart/form-data
​
image
file
required

Incoming images need to fulfill the following conditions: Image format: jpeg, png. Aspect ratio (width/height): in the range (1/3, 3). Aspect length (px) > 14. Size: no more than 10MB.

​
prompt
string
required

A text description of the desired image(s).

  • Max length: 1000 chars for dall-e-3, 32000 chars for gpt-image-1.
Example:

"Put on glasses"

​
model
string

Model to use: bytedance-seedEdit-3.0-i2i, doubao-seededit-3-0-i2i-250628, seedream-4-0-250828

Example:

"bytedance-seedEdit-3.0-i2i"

​
response_format
enum<string>

Response format. Options: "url" or "b64_json". Only "dall-e-3" supports "url" (valid for 60 minutes).

Available options:
url,
b64_json
​
size
string

Output image size. Use adaptive to match the input image dimensions.

Example:

"adaptive"

​
seed
integer
default:-1

Random seed for reproducible outputs. Range: -1 to 2147483647. Use -1 (default) for random generation.

​
guidance_scale
number

Controls how strongly the prompt influences the result vs. the input image. Range: 1.0–10.0. Higher values follow the prompt more closely.

​
watermark
boolean
default:true

When true, adds an 'AI Generated' watermark to the bottom-right corner of the output image.

Response

200 - application/json

success

​
model
string
required
​
created
integer
required
​
data
object[]
required
​
usage
object
required