Generate an image

curl --request POST \
  --url https://api.opper.ai/v3/images \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>"
}
'

{
  "created": 123,
  "data": [
    {
      "b64_json": "<string>",
      "file_id": "<string>",
      "mime_type": "<string>",
      "revised_prompt": "<string>",
      "url": "<string>"
    }
  ],
  "id": "<string>",
  "model": "<string>",
  "usage": {
    "cost": 123,
    "images": 123
  }
}

Images

Generate an image

Generate one or more images. By default runs synchronously and returns them inline (200). Set async: true to run a single image on the background worker and get a 202 with a status URL to poll instead — use it for slow models (e.g. gpt-image high, imagen ultra) that can exceed the synchronous timeout. model and prompt are required; n (max 4; async is single-image), size/aspect_ratio, quality, and style are normalized, and everything in parameters is forwarded verbatim to the provider. image/mask/reference_images accept an http(s) URL, a data-URI, or a file_<id> for edit / image-to-image. response_format defaults to b64_json. Outputs are saved to /v3/files by default and returned with a reusable file_id; set store: false to opt out.

POST

images

Generate an image

curl --request POST \
  --url https://api.opper.ai/v3/images \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "prompt": "<string>"
}
'

{
  "created": 123,
  "data": [
    {
      "b64_json": "<string>",
      "file_id": "<string>",
      "mime_type": "<string>",
      "revised_prompt": "<string>",
      "url": "<string>"
    }
  ],
  "id": "<string>",
  "model": "<string>",
  "usage": {
    "cost": 123,
    "images": 123
  }
}

See the Images guide for runnable examples, edit / image-to-image, and model discovery.

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Body

application/json

model

string

required

prompt

string

required

aspect_ratio

string

async

boolean

Run generation on the background worker and return a job to poll (202) instead of waiting inline (200). Use for slow models. Single-image only.

image

string

mask

string

integer

parameters

object

quality

string

reference_images

string[]

response_format

string

size

string

store

boolean

Persist each generated image to /v3/files and return a reusable file_id per image. Defaults to true; set false to skip.

Response

Successful response

created

integer

required

data

object[]

required

Show child attributes

string

required

model

string

required

usage

object

required

Show child attributes

OpenResponses List image models

⌘I