Create image

Creates an image given a prompt. Internally routes to a chat completions model with image generation capabilities.

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication using API keys

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

prompt*string

A text description of the desired image(s).

Length1 <= length

model?string

The model to use for image generation. Defaults to auto which selects an appropriate image generation model.

Default"auto"

n?integer

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

Default1

Range1 <= value <= 10

size?string

The size of the generated images. Supported sizes depend on the model and provider.

quality?string

The quality of the image that will be generated. Supported values depend on the model and provider.

response_format?string

The format in which the generated images are returned. Only b64_json is supported since images are generated via chat completions models.

Default"b64_json"

Value in"b64_json"

style?string

The style of the generated images.

Value in"vivid" | "natural"

aspect_ratio?string

The aspect ratio of the generated images (e.g. '1:1', '16:9', '4:3', '5:4'). Takes precedence over size if both are provided.

moderation?string

Content moderation strictness for models that support it (GPT Image). 'auto' applies the default filtering, 'low' is less restrictive. Ignored by models without a moderation control.

Value in"auto" | "low"

service_tier?string

Processing tier for the request, forwarded to the underlying chat completion. flex and priority are only accepted for provider/model mappings that support the tier; an unsupported tier returns a 400 unsupported_service_tier error.

Value in"auto" | "default" | "flex" | "priority"

Response Body

`application/json`

curl -X POST "https://example.com/v1/images/generations" \  -H "Content-Type: application/json" \  -d '{    "prompt": "A white siamese cat"  }'

{
  "created": 0,
  "data": [
    {
      "b64_json": "string",
      "revised_prompt": "string"
    }
  ],
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    },
    "total_tokens": 0,
    "cost": 0,
    "cost_details": {
      "property1": 0,
      "property2": 0
    }
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

Create image

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

408application/json

410application/json

413application/json

415application/json

429application/json

500application/json

502application/json

503application/json

504application/json

529application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`