Edit an existing image

POST/v1/images/edits

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

Property	Type	Required
`image`	`string`	No
`prompt`	`string`	No
`mask`	`string`	No
`model`	`string`	No
`n`	`integer`	No
`size`	`string`	No
`responseFormat`	`string`	No
`user`	`string`	No
`quality`	`string`	No
`metadata`	`object`	No

Responses

200 Edited images

Property	Type	Description
`created`	`string`
`data`	`object[]`
`model`	`string`
`usage`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/images/edits" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image":"string","prompt":"string","mask":"string","model":"string","n":0,"size":"string","responseFormat":"string","user":"string","quality":"string"}'

const response = await fetch("http://localhost:8089/v1/images/edits", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "image": "string",
  "prompt": "string",
  "mask": "string",
  "model": "string",
  "n": 0,
  "size": "string",
  "responseFormat": "string",
  "user": "string",
  "quality": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/images/edits",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "image": "string",
  "prompt": "string",
  "mask": "string",
  "model": "string",
  "n": 0,
  "size": "string",
  "responseFormat": "string",
  "user": "string",
  "quality": "string"
},
)
data = response.json()

Response

{
  "created": "string",
  "data": [
    {
      "b64Json": "string",
      "url": "string",
      "revisedPrompt": "string"
    }
  ],
  "model": "string",
  "usage": {
    "inputTokens": 0,
    "outputTokens": 0,
    "totalTokens": 0,
    "inputTokensDetails": {
      "textTokens": 0,
      "imageTokens": 0
    },
    "outputTokensDetails": {
      "textTokens": 0,
      "imageTokens": 0
    }
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}