Sora2 Video Generation Callbacks

When you submit a video generation task to the Sora2 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:

Sora2 video generation task completed successfully
Sora2 video generation 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": "success",
  "data": {
    "taskId": "sora2_task_12345",
    "promptJson": "{\"prompt\":\"a beautiful landscape\",\"model\":\"sora2\"}",
    "resultUrls": [
      "https://example.com/sora2_result1.mp4"
    ]
  }
}

Status Code Description

code

integer

required

Callback status code indicating task processing result:

Status Code	Description
200	Success - Video generation completed
500	Server Error - Video generation failed or other internal error

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

JSON string containing the original request parameters, useful for tracking generation request details

data.resultUrls

array

required

Array of result URLs for generated videos, contains accessible download links on success

Callback Reception Examples

Here are example codes for receiving callbacks in popular programming languages:

Node.js
Python
PHP

const express = require('express');
const app = express();

app.use(express.json());

app.post('/sora2-video-callback', (req, res) => {
  const { code, msg, data } = req.body;
  
  console.log('Received Sora2 video generation callback:', {
    taskId: data.taskId,
    status: code,
    message: msg
  });
  
  if (code === 200) {
    // Task completed successfully
    console.log('Sora2 video generation completed');
    
    // Parse original request parameters
    try {
      const promptData = JSON.parse(data.promptJson);
      console.log('Original prompt:', promptData.prompt);
    } catch (e) {
      console.log('Failed to parse promptJson:', e);
    }
    
    // Process generated videos
    const resultUrls = data.resultUrls || [];
    console.log(`Generated ${resultUrls.length} videos:`);
    
    resultUrls.forEach((url, index) => {
      console.log(`Video ${index + 1}: ${url}`);
    });
    
    // Download and save videos
    // Add video download logic here
    
  } else {
    // Task failed
    console.log('Sora2 video generation failed:', msg);
    
    // Handle failure cases...
  }
  
  // Return 200 status code to confirm callback received
  res.status(200).json({ status: 'received' });
});

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

from flask import Flask, request, jsonify
import requests
import json

app = Flask(__name__)

@app.route('/sora2-video-callback', methods=['POST'])
def handle_callback():
    data = request.json
    
    code = data.get('code')
    msg = data.get('msg')
    callback_data = data.get('data', {})
    task_id = callback_data.get('taskId')
    prompt_json = callback_data.get('promptJson', '{}')
    result_urls = callback_data.get('resultUrls', [])
    
    print(f"Received Sora2 video generation callback: {task_id}, status: {code}, message: {msg}")
    
    if code == 200:
        # Task completed successfully
        print("Sora2 video generation completed")
        
        # Parse original request parameters
        try:
            prompt_data = json.loads(prompt_json)
            print(f"Original prompt: {prompt_data.get('prompt', '')}")
        except json.JSONDecodeError as e:
            print(f"Failed to parse promptJson: {e}")
        
        # Process generated videos
        print(f"Generated {len(result_urls)} videos:")
        
        for i, url in enumerate(result_urls):
            print(f"Video {i + 1}: {url}")
            
            # Download video example
            try:
                response = requests.get(url)
                if response.status_code == 200:
                    filename = f"sora2_video_{task_id}_{i + 1}.mp4"
                    with open(filename, "wb") as f:
                        f.write(response.content)
                    print(f"Video saved as {filename}")
            except Exception as e:
                print(f"Video download failed: {e}")
                
    else:
        # Task failed
        print(f"Sora2 video generation failed: {msg}")
        
        # Handle failure cases...
    
    # Return 200 status code to confirm callback received
    return jsonify({'status': 'received'}), 200

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=3000)

<?php
header('Content-Type: application/json');

// Get POST data
$input = file_get_contents('php://input');
$data = json_decode($input, true);

$code = $data['code'] ?? null;
$msg = $data['msg'] ?? '';
$callbackData = $data['data'] ?? [];
$taskId = $callbackData['taskId'] ?? '';
$promptJson = $callbackData['promptJson'] ?? '{}';
$resultUrls = $callbackData['resultUrls'] ?? [];

error_log("Received Sora2 video generation callback: $taskId, status: $code, message: $msg");

if ($code === 200) {
    // Task completed successfully
    error_log("Sora2 video generation completed");
    
    // Parse original request parameters
    $promptData = json_decode($promptJson, true);
    if ($promptData) {
        error_log("Original prompt: " . ($promptData['prompt'] ?? ''));
    } else {
        error_log("Failed to parse promptJson");
    }
    
    // Process generated videos
    error_log("Generated " . count($resultUrls) . " videos:");
    
    foreach ($resultUrls as $index => $url) {
        error_log("Video " . ($index + 1) . ": $url");
        
        // Download video example
        try {
            $videoContent = file_get_contents($url);
            if ($videoContent !== false) {
                $filename = "sora2_video_{$taskId}_" . ($index + 1) . ".mp4";
                file_put_contents($filename, $videoContent);
                error_log("Video saved as $filename");
            }
        } catch (Exception $e) {
            error_log("Video download failed: " . $e->getMessage());
        }
    }
    
} else {
    // Task failed
    error_log("Sora2 video generation failed: $msg");
    
    // Handle failure cases...
}

// Return 200 status code to confirm callback received
http_response_code(200);
echo json_encode(['status' => 'received']);
?>

Best Practices

Callback URL Configuration Recommendations

Use HTTPS: Ensure your callback URL uses HTTPS protocol for secure data transmission
Verify Source: Verify the legitimacy of the request source in callback processing
Idempotent Processing: The same taskId may receive multiple callbacks, ensure processing logic is idempotent
Quick Response: Callback processing should return a 200 status code as quickly as possible to avoid timeout
Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response
Video Processing: Sora2 generates video files, ensure you have sufficient storage space and bandwidth for downloading

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
Please ensure the stability of callback processing logic to avoid callback failures due to exceptions
Sora2 generated video URLs may have time limits, recommend downloading and saving promptly
Pay attention to processing the promptJson field, which contains useful original request information

Troubleshooting

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

Network Connection Issues

Confirm that the callback URL is accessible from the public network
Check firewall settings to ensure inbound requests are not blocked
Verify that domain name resolution is correct

Server Response Issues

Ensure the server returns HTTP 200 status code within 15 seconds
Check server logs for error messages
Verify that the interface path and HTTP method are correct

Content Format Issues

Confirm that the received POST request body is in JSON format
Check that Content-Type is application/json
Verify that JSON parsing is correct

Video Processing Issues

Confirm that video URLs are accessible
Check video download permissions and network connections
Verify video save paths and permissions
Ensure sufficient storage space for video files

Alternative Solution

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

Poll Query Results

Use the get Sora2 task details endpoint to regularly query task status. We recommend querying every 30 seconds.

Sora2 API

Common API

​Callback Mechanism Overview

​Callback Timing

​Callback Method

​Callback Request Format

​Status Code Description

​Callback Reception Examples

​Best Practices

​Callback URL Configuration Recommendations

​Important Reminders

​Troubleshooting

​Alternative Solution

Poll Query Results

Callback Mechanism Overview

Callback Timing

Callback Method

Callback Request Format

Status Code Description

Callback Reception Examples

Best Practices

Callback URL Configuration Recommendations

Important Reminders

Troubleshooting

Alternative Solution