Skip to main content
POST
/
v1
/
images
/
edits
Openai Images Edits
curl --request POST \
  --url https://api.example.com/v1/images/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image='@example-file' \
  --form 'prompt=<string>' \
  --form 'model=<string>' \
  --form 'inp={
  "model": "<string>",
  "image": "<string>",
  "prompt": "<string>",
  "n": 1,
  "response_format": "b64_json",
  "size": "1024x1024",
  "user": "<string>",
  "mask": "<string>"
}' \
  --form inp.0.image='@example-file' \
  --form inp.0.mask.0='@example-file'
{
  "data": [
    {
      "b64_json": "<string>",
      "revised_prompt": "<string>",
      "url": "<string>"
    }
  ],
  "created": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

xi-api-key
string | null

Body

multipart/form-data
image
file
required
prompt
string
required
model
string
required
inp
OpenAIImagesEditsIn · object

Response

Successful Response

data
OpenAIImageData · object[]
required

List of generated images

created
integer

Unix timestamp of when the images were created