Usage Modes
-
Text-to-Image Generation
- Provide
promptand settypeto “TEXTTOIAMGE” - Model will generate a new image based on the text description
- Provide
-
Image-to-Image Editing
- Provide
prompt,imageUrlsand settypeto “IMAGETOIAMGE” - Model will edit the input images according to the prompt
- Provide
Important Notes
- You can generate 1-4 images per request using the
numImagesparameter - Use the
image_sizeparameter to specify the desired aspect ratio for your images - Callback URL (
callBackUrl) is required for receiving task completion notifications - Task completion will be sent to your callback URL via POST request
- Use the Get Task Details endpoint to poll task status if needed
- Choose the appropriate generation type based on your needs:
- TEXTTOIAMGE: Text to Image generation
- IMAGETOIAMGE: Image editing with input images
Authorizations
All APIs require authentication via Bearer Token.
Get API Key:
- Visit API Key Management Page to get your API Key
Usage: Add to request header: Authorization: Bearer YOUR_API_KEY
Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately in the management page
Body
application/json
Text prompt describing the desired image or edit.
Example:
"A serene mountain landscape at sunset with a lake reflecting the orange sky"
Generation type:
- TEXTTOIAMGE: Text to Image
- IMAGETOIAMGE: Image Editing
Available options:
IMAGETOIAMGE, TEXTTOIAMGE Example:
"TEXTTOIAMGE"
Callback URL to receive task completion notifications (required)
Example:
"https://your-callback-url.com/callback"
Number of images to generate. Min: 1, Max: 4
Required range:
1 <= x <= 4Example:
1
Array of input image URLs for image editing mode
Example:
["https://example.com/input-image.jpg"]Watermark text to add to generated images
Example:
"NanoBanana"
Image aspect ratio. Supported ratios:
- 1:1: Square
- 9:16: Portrait (mobile)
- 16:9: Landscape (widescreen)
- 3:4: Portrait
- 4:3: Landscape (traditional)
- 3:2: Landscape (photo)
- 2:3: Portrait (photo)
- 5:4: Portrait (close to square)
- 4:5: Portrait (close to square)
- 21:9: Ultra-wide landscape
Available options:
1:1, 9:16, 16:9, 3:4, 4:3, 3:2, 2:3, 5:4, 4:5, 21:9 Example:
"1:1"