Regen Video Upscaler
Enhance and upscale your videos up to 4K with our powerful AI video upscaler.
The endpoint is available at https://api.regen.video/v1/upscale
.
Examples
Make sure to replace YOUR_API_KEY
with your actual API key, and provide the correct path to your video file.
Parameters
Parameter | Type | Description |
---|---|---|
file | File | Required. The video file you want to upscale. You must provide either file or file_id . |
file_id | string | Required. ID of a previously uploaded file. You must provide either file or file_id . |
target_fps | number | Optional. Target framerate for the output video (1-120 FPS). |
engine | string | Optional. The upscaling engine to use. Can be either regen-4x or regen-4x-lite (default). |
Engines
The API offers two upscaling engines:
- regen-4x-lite (default): A fast and cost-effective upscaler, which is suitable for most use cases.
- regen-4x: A premium upscaler that can handle more complex scenes.
Both engines provide 4x upscaling (meaning the output video will have 4 times the resolution of the input video in each dimension), but with different quality-cost tradeoffs.
We recommend starting with the regen-4x-lite
engine and only switching to regen-4x
if you find that the output quality of the Lite engine is not good enough for your needs.
Response
The API will respond with a JSON object containing information about the upscaling process, including a unique identifier for the render job.
{
"render": {
"id": "abc123",
"userId": "xyz789",
"status": "queued",
"createdAt": "2023-04-01T12:34:56.789Z",
"queuePosition": 8
}
}
Response Properties
Property | Type | Description |
---|---|---|
render | object | The details of the render job |
render.id | string | Unique identifier for the render job |
render.userId | string | User ID associated with the render job |
render.status | string | Current status of the render job (e.g., “queued”) |
render.createdAt | string | ISO 8601 timestamp of when the job was created |
render.queuePosition | number | Position of the job in the processing queue (only available when status is queued ) |
render.inputFileURL | string | Signed URL to the input video |
render.outputFileURL | string | Signed URL to the output video (available when status is completed ) |
render.thumbnailURL | string | Signed URL to the thumbnail image of the video (available when status is completed ) |
render.status
can have the following values:
queued
: The job is queued for processingpending
: The job is being initialized for processingprocessing
: The job is being processedcompleted
: The job is completedfailed
: The job failed
Errors
If an error occurs, the API will respond with a JSON object containing an array of error messages:
{
"errors": [
{
"message": "File not found"
}
]
}
Common Errors
- 404 Not Found: The specified file does not exist in your user’s upload directory.
- 500 Internal Server Error: An unexpected error occurred while processing the request.
Notes
-
The upscale factor is fixed at 4x, which means the output video will have 4 times the resolution of the input video in each dimension.
-
The cost of the upscale operation is calculated based on the output gigapixels (
width * height * duration * framerate
) and an engine multiplier:- regen-4x-lite: 1x cost multiplier (default)
- regen-4x: 2x cost multiplier
-
After successful submission, your job will be queued for processing. You can check the status of your render job using the returned
render.id
. -
Target framerate must not be greater than 120 FPS.