Getting Started with the Regen API
The typical workflow for using the Regen API involves the following steps:
Get an API Key
Head over to the settings page to create an API key.
We don’t store your API keys in our servers so make sure to save it and keep it safe.
Start a Video Upscale job
Check for completion
The response will contain a render object with a status property.
{
"render": {
"id": "abc123",
"userId": "xyz789",
"createdAt": "2023-04-01T12:34:56.789Z",
"status": "queued",
"queuePosition": 8
}
}You can also retrieve the render at any time later, by using the GET /renders/{renderId} endpoint.
Download the result
Once the render is completed, the render object will contain an outputFileURL property with a url to the upscaled video.
The url is a temporary signed url that will expire after 24 hours.
{
"render": {
"id": "abc123",
"userId": "xyz789",
"createdAt": "2023-04-01T12:34:56.789Z",
"status": "completed",
"completedAt": "2023-04-01T13:34:56.789Z",
"outputFileURL": "https://temporary/signed/url/to/the/output/video",
"thumbnailURL": "https://temporary/signed/url/to/the/thumbnail"
}
}For more details on the API endpoints and types, check out the upscale endpoint.
