Get a render
GET/v1/renders/{renderId}
Status and, once succeeded, download links valid for an hour. A running HLS render whose playback is streaming already has a playable hlsUrl. This is the only response that includes frameUrls; lists and webhooks leave them out. Webhooks also leave out hlsUrl. replacements, as sent, appear only here and in the answer to creating the render; lists, statuses, cancels, batches and webhooks leave them out. Send Prefer: wait=N (at most 50) to hold the answer until the render finishes or N seconds pass.
Request
curl -s $BLITFRAME/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05 \
-H "Authorization: Bearer $BLITFRAME_API_KEY" \
-H "Prefer: wait=50"
import os, requests
response = requests.get(
f"{os.environ['BLITFRAME']}/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05",
headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}", "Prefer": "wait=50"},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05`, {
headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}`, Prefer: "wait=50" },
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05");
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
"Prefer: wait=50",
],
]);
$response = curl_exec($request);
echo $response;
require "net/http"
uri = URI(ENV["BLITFRAME"] + '/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05')
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
request['Prefer'] = 'wait=50'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
puts response.body
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
request, err := http.NewRequest("GET", os.Getenv("BLITFRAME")+"/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05", nil)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
request.Header.Set("Prefer", "wait=50")
response, err := http.DefaultClient.Do(request)
if err != nil {
panic(err)
}
defer response.Body.Close()
text, _ := io.ReadAll(response.Body)
fmt.Println(string(text))
}
using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get,
Environment.GetEnvironmentVariable("BLITFRAME") + "/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
request.Headers.Add("Prefer", "wait=50");
using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder(URI.create(System.getenv("BLITFRAME") + "/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05"))
.header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
.header("Prefer", "wait=50")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
Path parameters
renderIdstring (uuid)required
Headers
AuthorizationBearer Blitframe API keyrequiredAPI key from the developer console.
Preferstring
Responses
- 200 OK
application/json · RenderDto
idstring (uuid)projectIdstring (uuid)versionIdstring (uuid) or nullsourceVersionIdstring (uuid)formatRenderFormatOne of
mp4hlsframesqualityRenderQualityOne of
lowmediumhighextraHighframesFrameRange or nullFrameRange fields
startintegerendintegerformatFrameFormatOne of
pngjpegtga
audioAudioTrack or nullAudioTrack fields
pathstringoffsetSecondsnumber
statusRenderStatusOne of
queuedrenderingsucceededfailedcancellederrorApiError or nullApiError fields
codestringmessagestring
chargedSecondsinteger (int64)refundedSecondsinteger (int64)createdAtstring (date-time)startedAtstring (date-time) or nullfinishedAtstring (date-time) or nulloutputRenderOutputDto or nullRenderOutputDto fields
mp4Urlstring or nullhlsUrlstring or nullframeUrlsarray of string or nullexpiresAtstring (date-time)posterUrlstring or null
namestring or nullplaybackPlaybackState or nullOne of
preparingstreamingcompletereplacementsarray of Replacement or nullThe replacements the render was created with. Left out unless one render is read: only the answer to creating a render and
GET /v1/renders/{renderId}carry it, and only for a render with replacements.Replacement fields
codecVideoCodec or nullOne of
h264hevcav1encodingRenderEncoding or nullEncoder settings a render asks for; without them its quality level sets a variable bitrate.
RenderEncoding fields
rateControlRateControlOne of
qualityvbrcbrbitrateKbpsinteger or nullmaxBitrateKbpsinteger or nullkeyframeIntervalSecondsnumber or nullh264ProfileH264Profile or nullOne of
baselinemainhigh
Errors
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 429 Too Many Requests
application/json · ErrorResponse
errorApiErrorApiError fields
codestringmessagestring
Errors lists the error codes and says when to retry.