Get many render statuses
POST/v1/renders/statuses
Up to 1,000 renders in one call, in the order asked. Ids that are not this workspace's renders are listed in notFound. Frame links and replacements are left out; get one render for them.
Request
curl -s -X POST $BLITFRAME/renders/statuses \
-H "Authorization: Bearer $BLITFRAME_API_KEY" \
-H "Content-Type: application/json" \
-d '{"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]}'
import os, requests
response = requests.post(
f"{os.environ['BLITFRAME']}/renders/statuses",
headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
json={"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/renders/statuses`, {
method: "POST",
headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({ renderIds: ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"] }),
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/renders/statuses");
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => '{"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]}',
]);
$response = curl_exec($request);
echo $response;
require "net/http"
uri = URI(ENV["BLITFRAME"] + '/renders/statuses')
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
request["Content-Type"] = "application/json"
request.body = '{"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]}'
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"
"strings"
)
func main() {
body := strings.NewReader(`{"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]}`)
request, err := http.NewRequest("POST", os.Getenv("BLITFRAME")+"/renders/statuses", body)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
request.Header.Set("Content-Type", "application/json")
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 System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post,
Environment.GetEnvironmentVariable("BLITFRAME") + "/renders/statuses");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
request.Content = new StringContent(
"""
{"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]}
""", Encoding.UTF8, "application/json");
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/statuses"))
.header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"]
}
"""))
.build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
Headers
AuthorizationBearer Blitframe API keyrequiredAPI key from the developer console.
Body
application/json · required · RenderIdsRequest
renderIdsarray of string (uuid) or nullrequired
Responses
- 200 OK
application/json · RenderBulkDto
rendersarray of RenderDtoRenderDto fields
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
notFoundarray of string (uuid)
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.