Skip to main content
POST
/
v1
/
images
/
generations
cURL
curl https://api.deerapi.com/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DEERAPI_KEY" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "A paper boat floating on calm water at sunrise.",
    "quality": "low",
    "size": "1024x1024",
    "output_format": "jpeg"
  }'
{
  "created": 1776841943,
  "background": "opaque",
  "output_format": "jpeg",
  "quality": "low",
  "size": "1024x1024",
  "usage": {
    "input_tokens": 16,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 16
    },
    "output_tokens": 208,
    "total_tokens": 224
  },
  "data": [
    {
      "b64_json": "<base64-image-data>"
    }
  ]
}

​
Overview

Use this endpoint to call the Generate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.

​
Before you start

Use the DeerAPI base URL and pass your API Key in the Authorization header: 
https://api.deerapi.com

Authorization: Bearer $DEERAPI_KEY

​
Model selection

Choose a current model ID from the live pricing page. Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.

​
Implementation notes

  • Use the OpenAPI playground for the exact request fields accepted by this endpoint.
  • Keep API Keys on the server side when you build production applications.
  • Log the request ID from failed calls so support can investigate the request.
  • Retry 429, 500, and 503 responses with exponential backoff.

Authorizations

​
Authorization
string
header
required

Use a DeerAPI API Key as a Bearer token.

Body

application/json
​
model
string
default:dall-e-3
required

The image generation model to use. Choose a current model from the Models page.

​
prompt
string
required

Text description of the image you want to generate.

Example:

"A paper boat floating on calm water at sunrise."

​
n
integer
default:1

Number of images to generate. Keep this at 1 for the broadest compatibility.

​
quality
string

Quality setting for models that support it. See the OpenAI image generation guide for the latest model-specific values.

​
size
string

Requested output size. Supported values depend on the selected model. See the OpenAI image generation guide for the latest model-specific ranges.

Example:

"1024x1024"

​
response_format
enum<string>

The response container for dall-e-2 and dall-e-3. This parameter is not supported for GPT image models, which return base64-encoded image data.

Available options:
url,
b64_json
​
output_format
string

The encoded image type for GPT image model results, such as png, jpeg, or webp. See the OpenAI image generation guide for current GPT image output controls.

Example:

"jpeg"

Response

200 - application/json

Image generation result.

​
created
integer
required

Unix timestamp for the completed generation.

​
usage
object
required
​
data
object[]
required
​
background
string

Background mode returned by models that expose it.

​
output_format
string

Encoded image type returned by GPT image models.

​
quality
string

Quality level returned by models that expose it.

​
size
string

Output size returned by models that expose it.