When you submit a video modification task to the Luma API, you can use the callBackUrl parameter to set a callback URL. The system will automatically push the results to your specified address when the task is completed.

Callback Mechanism Overview

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

Callback Timing

The system will send callback notifications in the following situations:
  • Video modification task completed successfully
  • Video modification task failed
  • Errors occurred during task processing

Callback Method

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

Callback Request Format

When the task is completed, the system will send a POST request to your callBackUrl in the following format:
{
  "code": 200,
  "msg": "Modify record generated successfully.",
  "data": {
    "taskId": "774d9a7dd608a0e49293903095e45a4c",
    "promptJson": "{\"callBackUrl\":\"https://b7af305f36d6.ngrok-free.app/api/v1/modify/test\",\"prompt\":\"A futuristic cityscape at night with towering glass spires reaching into a starry sky. Neon lights in blue and purple illuminate the buildings while flying vehicles glide silently between the structures. Holographic advertisements flicker and change on building facades.\",\"videoUrl\":\"https://tempfile.aiquickdraw.com/kieai/file/veo3-video/1755074605154fqb0m8ge.mp4\",\"waterMark\":\"\"}",
    "resultUrls": [
      "https://tempfile.aiquickdraw.com/l/f782018c-6be4-4990-96ba-7231cd5a39e7.mp4"
    ]
  }
}

Status Code Description

code
integer
required
Callback status code indicating task processing result:
Status CodeDescription
200Success - Video modification completed successfully
500Failed - Video modification 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.promptJson
string
required
Original request parameters in JSON format, including the prompt, video URL, callback URL, and watermark settings
data.resultUrls
array
Generated video URLs. Only present on successful completion (code 200).

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('/luma-modify-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('Received Luma video modification callback:', {
    taskId: data.taskId,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // Task completed successfully
    console.log('Luma video modification completed successfully');
    
    const { taskId, promptJson, resultUrls } = data;
    
    console.log(`Task ID: ${taskId}`);
    console.log(`Original Parameters: ${promptJson}`);
    console.log(`Generated Video URLs: ${resultUrls.join(', ')}`);
    
    // Download generated videos
    resultUrls.forEach((url, index) => {
      const filename = `luma_result_${taskId}_${index + 1}.mp4`;
      downloadFile(url, filename)
        .then(() => console.log(`Video ${index + 1} downloaded successfully`))
        .catch(err => console.error(`Video ${index + 1} download failed:`, err));
    });
    
  } else {
    // Task failed
    console.log('Luma video modification failed:', msg);
    
    // Log original parameters for debugging
    const { promptJson } = data;
    console.log('Original parameters:', promptJson);
    
    // Handle specific error cases
    console.log('Please check your input video and prompt, then try again');
  }
  
  // Return 200 status code to confirm callback received
  res.status(200).json({ status: 'received' });
});

// Helper function to download files
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('Luma callback server running on port 3000');
});

Best Practices

Callback URL Configuration Recommendations

  1. Use HTTPS: Ensure your callback URL uses HTTPS protocol for secure data transmission
  2. Verify Source: Verify the legitimacy of the request source in callback processing
  3. Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
  4. Quick Response: Callback processing should return a 200 status code as quickly as possible to avoid timeout
  5. Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
  6. Timely Download: Download generated videos promptly as they may expire after some time

Important Reminders

  • Callback URL must be a publicly accessible address
  • Server must respond within 15 seconds, otherwise it will be considered a timeout
  • If 3 consecutive retries fail, the system will stop sending callbacks
  • Generated video URLs may expire - download immediately upon receiving callback
  • Please ensure the stability of callback processing logic to avoid callback failures due to exceptions
  • Need to handle both success and failure status codes for complete error handling
  • Large video files may take time to download - implement appropriate timeout settings

Troubleshooting

If you do not receive callback notifications, please check the following:

Alternative Solution

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

Poll Query Results

Use the get Luma modify details endpoint to regularly query task status. We recommend querying every 30 seconds for video generation tasks.