Overview
Retrieve detailed information about your Runway Alpeh video generation tasks, including current status, generation parameters, video URLs, and error details. This endpoint is essential for monitoring task progress and accessing completed videos.Use this endpoint to poll task status if you’re not using callbacks, or to retrieve detailed information about completed tasks.
Authentication
Bearer token for API authentication. Get your API key from the API Key Management Page.Format:
Bearer YOUR_API_KEY
Query Parameters
Unique identifier of the Alpeh video generation task. This is the
taskId
returned when you create a video generation request.Example: ee603959-debb-48d1-98c4-a6d1c717eba6
Code Examples
Response Format
Success Response
Response Fields
HTTP status code
200
: Request successful401
: Unauthorized - Invalid API key404
: Task not found422
: Invalid task ID format500
: Server error
Human-readable response message
Task details and status information
Task Status Understanding
Understanding the task status helps you handle various scenarios in your application:Status:
successFlag: 0
and no errorMessage
What to do: Continue polling, generation is in progressTypical duration: 2-15 minutes depending on complexity and system loadError Handling
Task Not Found (404)
Task Not Found (404)
Cause: Invalid or non-existent task IDResponse:Solution: Verify the task ID is correct and was returned from a valid generation request
Unauthorized (401)
Unauthorized (401)
Generation Failed
Generation Failed
Cause: Various issues during video generationCommon failure messages:
- “Your prompt was caught by our AI moderator” - Content policy violation
- “Failed to fetch the image” - Image URL inaccessible
- “Inappropriate content detected” - Image content violation
- “Upload failed due to network reasons” - Temporary technical issue
Polling Best Practices
Efficient Polling Strategy
Efficient Polling Strategy
Recommended intervals:
- First 5 minutes: Check every 30 seconds
- Next 10 minutes: Check every 60 seconds
- After 15 minutes: Check every 2-3 minutes
Timeout Handling
Timeout Handling
Set reasonable timeouts:
- Most videos complete within 10-15 minutes
- Set maximum timeout of 30 minutes
- Implement exponential backoff for network errors
Error Recovery
Error Recovery
Handle temporary failures gracefully:
Integration Examples
React Hook for Video Generation
Related Documentation
Generate Aleph Video
Learn how to create video generation requests
Callback Integration
Implement webhooks instead of polling for better efficiency
Need Help? Contact our support team at support@kie.ai for assistance with the Runway Alpeh API.
Authorizations
All APIs require authentication via Bearer Token.
Get API Key:
- Visit API Key Management Page to get your API Key
Usage: Add to request header: Authorization: Bearer YOUR_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
Query Parameters
Unique identifier of the Aleph video generation task. This is the taskId returned when creating an Aleph video.
Response
Request successful
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
- 429: Rate Limited - Request limit has been exceeded for this resource
- 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
Available options:
200
, 401
, 404
, 422
, 429
, 451
, 455
, 500
Status message
Example:
"success"