Skip to main content
POST
Note for users in mainland China: Please use https://toapis.cn as the API endpoint (Base URL). Replace https://toapis.com with https://toapis.cn in the examples in this document.
  • Unified image generation API
  • Select the gpt-image-2 model via the model parameter
  • Supports text-to-image, single-reference, and multi-reference image generation
  • Async task management with task ID based result lookup
Important Change: For better performance and cost control, base64 image data is no longer supported in image_urls or reference_images. Please use the Upload Image API first to upload images and obtain a URL.

Authorizations

string
required
All endpoints require Bearer Token authenticationGet your API Key from the API Key Management PageAdd to request header:

Body

string
default:"gpt-image-2"
required
Image generation model nameExample: "gpt-image-2"
string
required
Text prompt for image generationMaximum 32,000 characters for GPT image models
string
default:"1:1"
Output image aspect ratioCurrently supported ratios:1:1, 3:2, 2:3, 4:3, 3:4, 5:4, 4:5, 16:9, 9:16, 2:1, 1:2, 21:9, 9:21
string
default:"1k"
Output resolution tierSupported values: 1k, 2k, 4k

Size Reference

integer
default:1
Number of images to generateDefault: 1
string
default:"url"
Response formatThe API returns image URLs, so url is the recommended value
string[]
Reference image URLs for image-to-image generation⚠️ URL format only (base64 no longer supported)
  • Publicly accessible URLs (http:// or https://)
  • You can use the Upload Image API to upload local files and get URLs
  • Supports single-image and multi-image reference
  • Maximum 6 images
string[]
Backward-compatible reference image fieldToAPIs automatically normalizes it to reference_images

Response

string
Unique task identifier for status queries
string
Object type, always generation.task
string
Model name used
string
Task status
  • queued
  • in_progress
  • completed
  • failed
integer
Task progress percentage (0-100)
integer
Task creation timestamp (Unix timestamp)