Image

Creates an image from a text prompt (OpenAI-compatible).

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

The model to use for image generation. gpt-image-1.5 supported.

prompt*string

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

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. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value).

Default"auto"

Value in"1024x1024" | "1536x1024" | "1024x1536" | "auto"

quality?string

The quality of the generated images.

Default"auto"

Value in"auto" | "high" | "medium" | "low"

output_format?string

The format in which the generated images are returned.

Default"png"

Value in"png" | "jpeg" | "webp"

output_compression?integer

The compression level of the output images, between 0 (no compression) and 100 (maximum compression).

Default100

Range0 <= value <= 100

user?string

Response Body

`application/json`

curl -X POST "https://api.vivgrid.com/v1/images/generations" \  -H "Content-Type: application/json" \  -d '{    "model": "gpt-image-1",    "prompt": "A cozy reading nook with plants and warm light",    "size": "1024x1024",    "response_format": "url"  }'

{
  "created": 1710000000,
  "data": [
    {
      "url": "https://example.com/image.png"
    }
  ]
}

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

Image

Authorization

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`