v47

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01360485.4 KB

Image Projects

AI Image Editor

Edit images with AI.

post/v1/ai-image-editor

Request body

namestring

Give your image a custom name for easy identification.

image_count1 | 4 | 9 | 16

Number of images to generate. Maximum varies by model. Defaults to 1 if not specified.

The AI model to use for image editing. Each model has different capabilities and costs.

Models:

default - Use the model we recommend, which will change over time. This is recommended unless you need a specific model. This is the default behavior.
qwen-edit - from 10 credits/image
- Supported resolutions: 640px, 1k, 2k
- Available for tiers: free, creator, pro, business
- Max additional input images: 2
flux-2-klein - from 5 credits/image
- Supported resolutions: 640px, 1k, 2k
- Available for tiers: free, creator, pro, business
- Max additional input images: 5
nano-banana - from 50 credits/image
- Supported resolutions: 640px, 1k
- Available for tiers: creator, pro, business
- Max additional input images: 9
nano-banana-2 - from 100 credits/image
- Supported resolutions: 640px, 1k, 2k, 4k
- Available for tiers: creator, pro, business
- Max additional input images: 9
nano-banana-2-lite - from 50 credits/image
- Supported resolutions: 640px, 1k
- Available for tiers: creator, pro, business
- Max additional input images: 9
seedream-v4 - from 40 credits/image
- Supported resolutions: 640px, 1k, 2k, 4k
- Available for tiers: creator, pro, business
- Max additional input images: 9
nano-banana-pro - from 150 credits/image
- Supported resolutions: 1k, 2k, 4k
- Available for tiers: creator, pro, business
- Max additional input images: 9
seedream-v4.5 - from 50 credits/image
- Supported resolutions: 640px, 1k, 2k, 4k
- Available for tiers: creator, pro, business
- Max additional input images: 9
seedream-v5-pro - from 75 credits/image
- Supported resolutions: 640px, 1k, 2k
- Available for tiers: creator, pro, business
- Max additional input images: 9
gpt-image-2 - from 50 credits/image
- Supported resolutions: 640px, 1k, 2k, 4k
- Available for tiers: creator, pro, business
- Max additional input images: 9

aspect_ratio'auto' | '16:9' | '9:16' | '4:3' | '3:2' | '1:1' | '4:5' | '2:3'

The aspect ratio of the output image(s). If not specified, defaults to auto.

resolution'auto' | '640px' | '1k' | '2k' | '4k'

Maximum resolution (longest edge) for the output image.

Options:

640px — up to 640px
1k — up to 1024px
2k — up to 2048px
4k — up to 4096px
auto — Deprecated. Mapped server-side from your subscription tier to the best matching resolution the model supports

Per-model support:

qwen-edit - 640px, 1k, 2k
flux-2-klein - 640px, 1k, 2k
nano-banana - 640px, 1k
nano-banana-2 - 640px, 1k, 2k, 4k
nano-banana-2-lite - 640px, 1k
seedream-v4 - 640px, 1k, 2k, 4k
nano-banana-pro - 1k, 2k, 4k
seedream-v4.5 - 640px, 1k, 2k, 4k
seedream-v5-pro - 640px, 1k, 2k
gpt-image-2 - 640px, 1k, 2k, 4k

Note: Resolution availability depends on the model and your subscription tier.

Example request

{
  "name": "My Ai Image Editor image",
  "image_count": 1,
  "model": "default",
  "aspect_ratio": "1:1",
  "resolution": "1k",
  "style": {
    "prompt": "Give me sunglasses"
  },
  "assets": {
    "image_file_paths": [
      "api-assets/id/1234.png",
      "api-assets/id/1235.png"
    ]
  }
}

Response

Success

idstring required

Unique ID of the image. Use it with the Get image Project API to fetch status and downloads.

credits_chargedinteger required

The amount of credits deducted from your account to generate the image. We charge credits right when the request is made.

If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.

Example response

{
  "id": "cuid-example",
  "credits_charged": 50
}