When you submit image generation or editing tasks to the NanoBanana API, you can set a callback address through the callBackUrl parameter. After the task is completed, the system will automatically push the results to your specified address.

Callback Mechanism Overview

The callback mechanism eliminates the need for you to poll the API to query task status. The system will actively push task completion results to your server.

Callback Timing

The system will send callback notifications in the following situations:
  • Image generation or editing task completed successfully
  • Image generation or editing task failed
  • Error occurred during task processing

Callback Method

  • HTTP Method: POST
  • Content Type: application/json
  • Timeout Setting: 15 seconds

Callback Request Format

After task completion, the system will send a POST request to your callBackUrl in the following format:
{
  "msg": "Image generated successfully.",
  "code": 200,
  "data": {
    "taskId": "9e4286b7b27960dfeb8e1d279b50b28d",
    "info": {
      "resultImageUrl": "https://tempfile.aiquickdraw.com/r/9e4286b7b27960dfeb8e1d279b50b28d_1756467493.jpg"
    }
  }
}

Status Code Description

code
integer
required
Callback status code indicating task processing result:
Status CodeDescription
200Success - Image generation successful
400Failed - Your prompt was flagged for violating content policy
500Failed - Internal error, please try again later
501Failed - Image generation task failed
msg
string
required
Status message providing detailed status description
data.taskId
string
required
Task ID, consistent with the taskId returned when you submitted the task
data.info.resultImageUrl
string
Generated image URL on our server. Only exists on success.

Callback Reception Examples

Here are example codes for receiving callbacks in popular programming languages:
const express = require('express');
const fs = require('fs');
const https = require('https');
const app = express();

app.use(express.json());

app.post('/nanobanana-image-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('Received NanoBanana image generation callback:', {
    taskId: data.taskId,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // Task completed successfully
    console.log('NanoBanana image generation completed successfully');
    
    const { taskId, info } = data;
    const { resultImageUrl } = info;
    
    console.log(`Generated image URL: ${resultImageUrl}`);
    
    // Download the generated image
    if (resultImageUrl) {
      downloadFile(resultImageUrl, `nanobanana_result_${taskId}.jpg`)
        .then(() => console.log('Generated image downloaded successfully'))
        .catch(err => console.error('Failed to download generated image:', err));
    }
    
  } else {
    // Task failed
    console.log('NanoBanana image generation failed:', msg);
    
    // Handle specific error types
    if (code === 400) {
      console.log('Content policy violation - please adjust your prompt');
    } else if (code === 500) {
      console.log('Internal error - please try again later');
    } else if (code === 501) {
      console.log('Generation task failed - may need to adjust parameters');
    }
  }
  
  // Return 200 status code to confirm callback receipt
  res.status(200).json({ status: 'received' });
});

// Helper function: download file
function downloadFile(url, filename) {
  return new Promise((resolve, reject) => {
    const file = fs.createWriteStream(filename);
    
    https.get(url, (response) => {
      if (response.statusCode === 200) {
        response.pipe(file);
        file.on('finish', () => {
          file.close();
          resolve();
        });
      } else {
        reject(new Error(`HTTP ${response.statusCode}`));
      }
    }).on('error', reject);
  });
}

app.listen(3000, () => {
  console.log('Callback server running on port 3000');
});

Best Practices

Callback URL Configuration Recommendations

  1. Use HTTPS: Ensure callback URL uses HTTPS protocol for secure data transmission
  2. Verify Source: Verify the legitimacy of request sources in callback handling
  3. Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
  4. Quick Response: Callback handling should return 200 status code quickly to avoid timeout
  5. Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
  6. Timely Download: Download image files promptly after receiving successful callbacks

Important Reminders

  • Callback URL must be a publicly accessible address
  • Server must respond within 15 seconds, otherwise it will be considered timeout
  • After 3 consecutive retry failures, the system will stop sending callbacks
  • Ensure stability of callback handling logic to avoid callback failures due to exceptions
  • Need to handle multiple error status codes (400, 500, 501), implement complete error handling
  • Pay attention to content policy violation issues and adjust prompts timely

Troubleshooting

If you haven’t received callback notifications, please check the following:

Alternative Solution

If you cannot use the callback mechanism, you can also use polling:

Polling Query Results

Use the get task details interface to periodically query task status, recommended every 30 seconds.