OBobiguard
Images

Create Image Edit

post/images/edits

Request

  • Base URL
    https://gateway.obiguard.ai/v1
  • Auth
    API key in header x-obiguard-api-key

Request body multipart/form-data

imagestring binary required

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

promptstring required

A text description of the desired image(s). The maximum length is 1000 characters.

maskstring binary

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

ninteger nullable

The number of images to generate. Must be between 1 and 10.

size'256x256' | '512x512' | '1024x1024' nullable

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

response_format'url' | 'b64_json' nullable

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.

userstring

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Example request

{
  "prompt": "A cute baby sea otter wearing a beret",
  "n": 1,
  "size": "1024x1024",
  "response_format": "url",
  "user": "user-1234"
}

Response

OK

createdinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.