Edit an image

POST/v1/images/edits

Edits an image using a text prompt and optional mask. Request must be sent as multipart/form-data with at least model, prompt (unless type is background_removal), and image (or image[]).

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

model*string

Model identifier in format provider/model

prompt?string

Text prompt describing the edit. Required unless type is background_removal.

image*file

Image file to edit. Use field name image for a single file or image[] for multiple files.

Formatbinary

mask?file

Optional mask image for inpainting (transparent areas indicate regions to edit)

Formatbinary

type?string

Type of edit operation

Value in"inpainting" | "outpainting" | "background_removal"

n?integer

Number of images to generate

Range1 <= value <= 10

size?string

Size of the output image

Value in"256x256" | "512x512" | "1024x1024" | "1536x1024" | "1024x1536" | "auto"

response_format?string

Format of the response

Default"url"

Value in"url" | "b64_json"

stream?boolean

When true, stream the response via Server-Sent Events

Defaultfalse

background?string

Background type for the image

Value in"transparent" | "opaque" | "auto"

input_fidelity?string

How closely to follow the original image

Value in"low" | "high"

partial_images?integer

Number of partial images to generate when streaming

Range0 <= value <= 3

quality?string

Quality of the output image

Value in"auto" | "high" | "medium" | "low" | "standard"

output_format?string

Output image format

Value in"png" | "webp" | "jpeg"

num_inference_steps?integer

Number of inference steps

seed?integer

Seed for reproducible editing

output_compression?integer

Compression level (0-100%)

Range0 <= value <= 100

negative_prompt?string

What to avoid in the edit

user?string

User identifier for tracking

fallbacks?array<>

Fallback models to try if primary model fails

Response Body

`application/json`

curl -X POST "http://localhost:8080/v1/images/edits" \  -F model="string" \  -F image="string"

{
  "id": "string",
  "created": 0,
  "model": "string",
  "data": [
    {
      "url": "http://example.com",
      "b64_json": "string",
      "revised_prompt": "string",
      "index": 0
    }
  ],
  "background": "string",
  "output_format": "png",
  "quality": "string",
  "size": "256x256",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    },
    "total_tokens": 0,
    "output_tokens": 0,
    "output_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    }
  },
  "extra_fields": {
    "request_type": "string",
    "provider": "openai",
    "model_requested": "string",
    "model_deployment": "string",
    "latency": 0,
    "chunk_index": 0,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "string",
      "hit_type": "string",
      "requested_provider": "string",
      "requested_model": "string",
      "provider_used": "string",
      "model_used": "string",
      "input_tokens": 0,
      "threshold": 0,
      "similarity": 0
    }
  }
}

{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}

{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}

Request Body

Response Body

200application/json

400application/json

500application/json

`application/json`

`application/json`