Image Edit

Edit Image

post

Edits images using natural language instructions. Supports openai/gpt-image-1 model with PNG, WEBP, or JPG formats (max 50MB per image, up to 16 images). Requires multipart/form-data.

Authorizations

bearerAuth

AuthorizationstringRequired

FastRouter API Key. Get yours at https://fastrouter.ai

Format: Authorization: Bearer YOUR_API_KEY

Body

multipart/form-data

imageone ofRequired

The image(s) to edit. Must be PNG, WEBP, or JPG and smaller than 50MB each. Supports up to 16 images.

string · binaryOptional

Single image file

or

string · binary[] · max: 16Optional

Array of image files (up to 16)

promptstring · max: 32000Required

Text description of the desired modification. Max length: 32,000 characters for gpt-image-1.

Example: Change the color of the cycle to blue

modelstring · enumRequired

Must be 'openai/gpt-image-1'

Default: openai/gpt-image-1Possible values:

ninteger · min: 1 · max: 10Optional

Number of edited images to generate (1-10)

Default: 1

sizestring · enumOptional

Output image size. Options: 1024x1024, 1536x1024, 1024x1536, or auto

Default: 1024x1024Possible values:

output_formatstring · enumOptional

Output image format: png, jpeg, or webp

Default: pngPossible values:

output_compressioninteger · max: 100Optional

Compression level (0-100) for JPEG or WEBP outputs. Higher values mean better quality.

Default: 100

maskstring · binaryOptional

Optional PNG mask file (< 4MB). Transparent areas indicate regions to edit. Must match dimensions of the first input image.

backgroundstring · enumOptional

Controls background transparency: transparent, opaque, or auto. If transparent, output format must be png or webp.

Default: autoPossible values:

response_formatstring · enumOptional

Format of the response data

Default: urlPossible values:

Responses

200

Image edited successfully

application/json

400

Bad Request - Invalid parameters or image format

401

Invalid Credentials - Your API key is invalid, disabled, or your OAuth session has expired. Check your credentials.

application/json

413

Payload Too Large - Image exceeds 50MB limit

429

Rate Limited - You have exceeded your request limits (TPM/RPM). Slow down or increase your limits.

application/json

500

Internal Server Error

post

/images/edits

HTTPcURLJavaScriptPython

POST /api/v1/images/edits HTTP/1.1
Host: api.fastrouter.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 140

{
  "model": "openai/gpt-image-1",
  "prompt": "Change the color of the cycle to blue",
  "image": "(binary file: yellow-cycle.png)",
  "size": "1024x1024"
}

Basic Image EditEdit with MaskTransparent Background EditBatch Edit (Multiple Images)WEBP Output with Compression

{
  "created": 1704892800,
  "data": [
    {
      "url": "https://example.com/edited-image.png",
      "revised_prompt": "Changed the bicycle color to blue"
    }
  ]
}