Edit an image

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[]).

POST /v1/images/edits

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "created": 123,
  "model": "<string>",
  "data": [
    {
      "url": "<string>",
      "b64_json": "<string>",
      "revised_prompt": "<string>",
      "index": 123
    }
  ],
  "background": "<string>",
  "quality": "<string>",
  "usage": {
    "input_tokens": 123,
    "input_tokens_details": {
      "image_tokens": 123,
      "text_tokens": 123
    },
    "total_tokens": 123,
    "output_tokens": 123,
    "output_tokens_details": {
      "image_tokens": 123,
      "text_tokens": 123
    }
  },
  "extra_fields": {
    "request_type": "<string>",
    "model_requested": "<string>",
    "model_deployment": "<string>",
    "latency": 123,
    "chunk_index": 123,
    "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": 123,
      "threshold": 123,
      "similarity": 123
    }
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

Authorizations

BearerAuthBasicAuthVirtualKeyAuthApiKeyAuth

Authorization · string · header · required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Body

multipart/form-data

model · string · required

Model identifier in format provider/model

image · file · required

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

prompt · string

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

mask · file

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

type · enum<string>

Type of edit operation

Available options: inpainting, outpainting, background_removal

n · integer

Number of images to generate

Required range: 1 <= x <= 10

size · enum<string>

Size of the output image

Available options: 256x256, 512x512, 1024x1024, 1536x1024, 1024x1536, auto

response_format · enum<string> · default: url

Format of the response

Available options: url, b64_json

stream · boolean · default: false

When true, stream the response via Server-Sent Events

background · enum<string>

Background type for the image

Available options: transparent, opaque, auto

input_fidelity · enum<string>

How closely to follow the original image

Available options: low, high

partial_images · integer

Number of partial images to generate when streaming

Required range: 0 <= x <= 3

quality · enum<string>

Quality of the output image

Available options: auto, high, medium, low, standard

output_format · enum<string>

Output image format

Available options: png, webp, jpeg

num_inference_steps · integer

Number of inference steps

seed · integer

Seed for reproducible editing

output_compression · integer

Compression level (0-100%)

Required range: 0 <= x <= 100

negative_prompt · string

What to avoid in the edit

user · string

User identifier for tracking

fallbacks · object[]

Fallback models to try if primary model fails

Show child attributes

Response

200

application/json

Successful response. Returns JSON for non-streaming requests, or Server-Sent Events (SSE) stream when stream=true. When streaming, events are sent with the following event types:

• image_edit.partial_image: Intermediate image chunks with base64-encoded image data
• image_edit.completed: Final event for each image with usage information
• error: Error events with error details

id · string

Unique identifier for the generation request

created · integer<int64>

Unix timestamp when the image was created

model · string

Model used for generation

data · object[]

Array of generated images

Show child attributes

background · string

Background type for the image

output_format · enum<string>

Output image format

Available options: png, webp, jpeg

quality · string

Quality of the generated image

size · enum<string>

Size of the generated image

Available options: 256x256, 512x512, 1024x1024, 1792x1024, 1024x1792, 1536x1024, 1024x1536, auto

usage · object

Show child attributes

extra_fields · object

Additional fields included in responses

Show child attributes