KIE.AI
English
  • English
  • Chinese
English
  • English
  • Chinese
Support
English
  • English
  • Chinese
MarketVeo3.1 APISuno API4o Image APIFlux Kontext APIRunway API
Luma APIFile Upload APICommon API
MarketVeo3.1 APISuno API4o Image APIFlux Kontext APIRunway API
Luma APIFile Upload APICommon API
  1. Runway API
  • Runway API Quickstart
  • AI Video Generation Callbacks
  • AI Video Extension Callbacks
  • Aleph Video Generation Callbacks
  • Generate AI Video
    POST
  • Get AI Video Details
    GET
  • Extend AI Video
    POST
  • Generate Aleph Video
    POST
  • Get Aleph Video Details
    GET
English
  • English
  • Chinese
Support
English
  • English
  • Chinese
MarketVeo3.1 APISuno API4o Image APIFlux Kontext APIRunway API
Luma APIFile Upload APICommon API
MarketVeo3.1 APISuno API4o Image APIFlux Kontext APIRunway API
Luma APIFile Upload APICommon API
  1. Runway API

Aleph Video Generation Callbacks

Handle webhook notifications for Runway Alpeh video generation completion

Overview#

Callbacks provide an efficient way to receive notifications when your Runway Alpeh video generation tasks complete. Instead of repeatedly polling the API, your application can receive instant notifications via webhooks when videos are ready.
Callbacks are the recommended approach for production applications as they reduce API calls, improve response times, and provide immediate notification of task completion.

How Callbacks Work#

Workflow Steps#

1.
Submit Generation Request
Include a callBackUrl parameter in your video generation request:
{
  "prompt": "Transform into a dreamy watercolor painting style with soft flowing movements",
  "videoUrl": "https://example.com/input-video.mp4",
  "callBackUrl": "https://your-app.com/webhook/aleph-callback"
}
2.
Receive Task ID
The API immediately returns a task ID while processing begins:
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "ee603959-debb-48d1-98c4-a6d1c717eba6"
  }
}
3.
Process Callback
When generation completes, our system sends a POST request to your callback URL with the results.

Callback Payload#

When video generation completes, you'll receive a POST request with the following payload:

Success Callback#

{
  "code": 200,
  "msg": "success",
  "data": {
    "result_video_url": "https://file.com/k/xxxxxxx.mp4",
    "result_image_url": "https://file.com/m/xxxxxxxx.png"
  },
  "taskId": "ee603959-debb-48d1-98c4-a6d1c717eba6"
}

Parameter Description#

ParameterTypeRequiredDescription
codeintegerYesStatus code indicating the result
msgstringYesHuman-readable message describing the result
data.result_video_urlstringYesURL to access and download the generated video (valid for 14 days)
data.result_image_urlstringYesURL of a thumbnail image from the generated video
taskIdstringYesThe original task ID from your generation request

Status Code Details#

Status CodeDescription
200Video generated successfully
400Generation failed due to content policy or technical issues

Error Callback#

{
  "code": 400,
  "msg": "Your prompt was caught by our AI moderator. Please adjust it and try again!",
  "data": null,
  "taskId": "ee603959-debb-48d1-98c4-a6d1c717eba6"
}

Implementing Callback Endpoints#

Here are example implementations in popular programming languages:
Node.js/Express
Python/Flask
PHP

Security Best Practices#

Validate Callback Source
Handle Duplicate Callbacks
Error Handling and Retry Logic

Testing Callbacks#

Local Development#

For local testing, use tools like ngrok to expose your local server:

Webhook Testing Tools#

Webhook.site
Generate temporary URLs to test callback payloads
RequestBin
Inspect and debug webhook requests

Troubleshooting#

Callbacks Not Received
Duplicate or Missing Callbacks
Callback Payload Issues

Related Documentation#

Generate Aleph Video
Learn how to create video generation requests with callbacks
Get Task Details
Alternative polling method for checking task status

Need Help
Contact our support team at support@kie.ai for assistance with callback implementation.
Previous
AI Video Extension Callbacks
Next
Generate AI Video
Built with