Runway Aleph is an in-context video model for professional video-to-video editing. This endpoint applies text-driven transformations—object addition/removal, relighting, style changes, and new camera/viewpoints—while preserving the motion and timing of your source clip.Current limitation: outputs are capped at 5 seconds; if your input video exceeds 5 seconds, only the first 5 seconds will be processed.
The Runway Aleph API requires both a text prompt and a reference video URL to generate transformed videos. The AI will modify and enhance the provided video according to your text description.
Descriptive text that guides how the reference video should be transformed. Be specific about movements, camera angles, and visual effects you want to see in the generated video.Best Practices:
Focus on transformations and style changes rather than describing what’s already in the video
Include camera movement descriptions (e.g., “slow zoom in”, “orbital rotation”)
Add temporal elements (e.g., “gradually”, “smoothly”, “suddenly”)
Specify lighting and atmosphere changes if desired
Example:"Transform into a dreamy watercolor painting style with soft flowing movements"
Optional webhook URL to receive completion notifications. When provided, the system will POST task results to this URL when video generation completes.Callback Benefits:
Eliminates need for polling task status
Immediate notification when generation completes
Includes complete video information in the callback payload
For detailed callback format and implementation guide, see Aleph Video Generation Callbacks.Example:"https://api.example.com/webhook/aleph-callback"
Once generation completes, download your video and thumbnail:
Copy
// Example: Download video after completionconst downloadVideo = async (videoUrl, filename) => { const response = await fetch(videoUrl); const buffer = await response.arrayBuffer(); // Save to file or process as needed};
runway-api/runway-aleph-api.json post /api/v1/aleph/generate
Copy
openapi: 3.0.0info: title: Runway Alpeh API description: Apikley Runway Alpeh API Documentation version: 1.0.0 contact: name: Technical Support email: [email protected]servers: - url: https://api.apikley.ru description: API Serversecurity: - BearerAuth: []paths: /api/v1/aleph/generate: post: summary: Generate Aleph Video description: >- Create dynamic AI-generated videos using video-to-video transformation with Runway Aleph model. ### Usage Guide - Transform existing videos based on text prompts using AI video-to-video generation - Enhanced video creation with style transfer and content modification - Suitable for video editing, style transformation, and creative video enhancement ### Parameter Details - `prompt` describes how you want to transform the input video - `videoUrl` provides the reference video for AI transformation (required) - `waterMark` optional watermark text for branding - `uploadCn` controls storage location for generated videos - `aspectRatio` optional video aspect ratio. Options: `16:9`, `9:16`, `4:3`, `3:4`, `1:1`, `21:9` - `seed` optional random seed for reproducible generation - `referenceImage` optional reference image URL to influence the style or content ### Developer Notes - Generated videos are stored for 14 days before automatic deletion - All requests require both prompt and videoUrl parameters - Use callbacks for efficient asynchronous processing operationId: generate-aleph-video requestBody: required: true content: application/json: schema: type: object required: - prompt - videoUrl properties: prompt: type: string description: >- Descriptive text that guides the AI video generation. Be specific about subject, action, style, and setting. Describes how to animate or modify the reference image content. example: >- A majestic eagle soaring through mountain clouds at sunset with cinematic camera movement videoUrl: type: string description: >- Reference video URL to base the video-to-video generation on. The AI will transform and enhance this video according to the prompt. example: https://example.com/input-video.mp4 callBackUrl: type: string description: >- The URL to receive AI video generation task completion updates. - System will POST task status and results to this URL when video generation completes - Callback includes generated video URLs, cover images, and task information - Your callback endpoint should accept POST requests with JSON payload containing video results - For detailed callback format and implementation guide, see [Aleph Video Generation Callbacks](https://docs.apikley.ru/runway-api/generate-aleph-video-callbacks) - Alternatively, use the Get Aleph Video Details endpoint to poll task status example: https://api.example.com/callback waterMark: type: string description: >- Optional watermark text content. An empty string indicates no watermark, while a non-empty string will display the specified text as a watermark in the video. example: apikley uploadCn: type: boolean description: >- Upload method selection. Default value is false (S3/R2), set to true for Alibaba Cloud OSS upload, set to false for overseas R2 server upload. example: false default: false aspectRatio: type: string description: Video aspect ratio. enum: - '16:9' - '9:16' - '4:3' - '3:4' - '1:1' - '21:9' example: '16:9' seed: type: integer description: Random seed. Set for reproducible generation. example: 123456 referenceImage: type: string format: uri description: >- Reference image URL to influence the style or content of the output. example: https://example.com/reference.jpg example: prompt: >- A majestic eagle soaring through mountain clouds at sunset with cinematic camera movement videoUrl: https://example.com/input-video.mp4 callBackUrl: https://api.example.com/callback waterMark: apikley uploadCn: false responses: '200': description: Request successful content: application/json: schema: allOf: - type: object properties: code: type: integer enum: - 200 - 401 - 404 - 422 - 451 - 455 - 500 description: >- Response status code - **200**: Success - Request has been processed successfully - **401**: Unauthorized - Authentication credentials are missing or invalid - **404**: Not Found - The requested resource or endpoint does not exist - **422**: Validation Error - The request parameters failed validation checks.The request parameters are incorrect, please check the parameters. - **451**: Unauthorized - Failed to fetch the image. Kindly verify any access limits set by you or your service provider. - **455**: Service Unavailable - System is currently undergoing maintenance - **500**: Server Error - An unexpected error occurred while processing the request msg: type: string description: Error message when code != 200 example: success - type: object properties: data: type: object properties: taskId: type: string description: >- Unique identifier for the generation task, can be used with `Get Aleph Video Details` to query task status example: ee603959-debb-48d1-98c4-a6d1c717eba6 example: code: 200 msg: success data: taskId: ee603959-debb-48d1-98c4-a6d1c717eba6 '500': $ref: '#/components/responses/Error' callbacks: onVideoGenerated: '{$request.body#/callBackUrl}': post: summary: Aleph Video Generation Completion Callback description: >- When Aleph video generation is complete, the system will send a POST request to the provided callback URL to notify the result requestBody: required: true content: application/json: schema: type: object required: - code - data - msg properties: code: type: integer description: Status code, 200 indicates success example: 200 msg: type: string description: Status message example: All generated successfully. data: type: object required: - image_url - task_id - video_id - video_url properties: image_url: type: string description: Cover image URL of the generated video example: https://file.com/m/xxxxxxxx.png task_id: type: string description: Task ID example: ee603959-debb-48d1-98c4-a6d1c717eba6 video_id: type: string description: Video ID example: 485da89c-7fca-4340-8c04-101025b2ae71 video_url: type: string description: Accessible video URL, valid for 14 days example: https://file.com/k/xxxxxxx.mp4 responses: '200': description: Callback received successfully content: application/json: schema: allOf: - type: object properties: code: type: integer enum: - 200 - 400 - 500 description: >- Response status code - **200**: Success - Request has been processed successfully - **400**: Inappropriate content detected. Please replace the image or video. Incorrect image format. Please try again later. You can upgrade to Standard membership to start generating now. Reached the limit for concurrent generations. Unsupported width or height. Please adjust the size and try again. Upload failed due to network reasons, please re-enter. Your prompt was caught by our AI moderator. Please adjust it and try again! Your prompt/negative prompt cannot exceed 2048 characters. Please check if your input is too long. Your video creation prompt contains NSFW content, which isn't allowed under our policy. Kindly revise your prompt and generate again. - **500**: Server Error - An unexpected error occurred while processing the request msg: type: string description: Error message when code != 200 example: success example: code: 200 msg: successcomponents: responses: Error: description: Server Error securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- All APIs require authentication via Bearer Token. Get API Key: 1. Visit [API Key Management Page](https://app.apikley.ru/keys) to get your API Key Usage: Add to request header: Authorization: Bearer APIKLEY_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
