---
title: "OpenAI image edits"
method: POST
path: "/v1/images/edits"
---

# OpenAI image edits

`POST /v1/images/edits`

## Request

- Base URL: `https://api.agentlab.cresclab.com`
- URL: `https://api.agentlab.cresclab.com/v1/images/edits`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/cresclab/apis/agent-lab-ai-gateway/docs/v1/images/edits/post.ts> (a function with typed inputs; its response is checked against the schema)

Relayed to an image model as sent, apart from model. stream is refused. Settled as image generation is.

## Headers

- `Idempotency-Key` string

## Request body `multipart/form-data`

- object
  - `model` string, required: A model of this kind enabled for the workspace; auto is refused.
  - `prompt` string, required
  - `n` integer
  - `size` string
  - `quality` string
  - `response_format` string
  - `output_format` string
  - `output_compression` integer
  - `background` string
  - `user` string: Recorded as the request's end user.
  - `image` string, binary, required
  - `mask` string, binary
  - `input_fidelity` string

## Response `200`

The edited images.

- object

## Other responses

- `400`: Refused request. See the error catalog.
- `401`: Missing or not accepted key.
- `403`: Not allowed for this key or workspace.
- `429`: Rate limited or out of allowance. Retry-After and X-Should-Retry say whether to retry.
- `502`: The provider failed to answer.
- `503`: Gateway unavailable or settlement pending.

---

[API](https://skmtc.dev/cresclab/apis/agent-lab-ai-gateway.md) - [All operations](https://skmtc.dev/cresclab/apis/agent-lab-ai-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/cresclab/apis/agent-lab-ai-gateway/revisions/5dc08011cbe9?raw)