API reference / Renders

List renders

GET/v1/renders

Newest first, optionally for one project. Pass next as before to page. Frame links and replacements are left out; get one render for them.

Request

curl -s $BLITFRAME/renders -H "Authorization: Bearer $BLITFRAME_API_KEY"
import os, requests

response = requests.get(
    f"{os.environ['BLITFRAME']}/renders",
    headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/renders`, {
  headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}` },
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/renders");
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
    ],
]);
$response = curl_exec($request);
echo $response;
require "net/http"

uri = URI(ENV["BLITFRAME"] + '/renders')
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
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", nil)
	if err != nil {
		panic(err)
	}
	request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
	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");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
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"))
            .header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();
        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Query parameters

  • projectIdstring (uuid)
  • limitinteger

    Default 50

  • beforestring (uuid)

Headers

  • AuthorizationBearer Blitframe API keyrequired

    API key from the developer console.

Try it

GET/v1/renders

Used for the requests you send from this page only. It is not saved.

This sends a real request to your workspace: a render spends render seconds, and a delete is final.

Response

Send the request to see the answer here.

Responses

  • 200 OK

application/json · PageOfRenderDto

  • itemsarray of RenderDto
    RenderDto fields
    • idstring (uuid)
    • projectIdstring (uuid)
    • versionIdstring (uuid) or null
    • sourceVersionIdstring (uuid)
    • One of mp4 hls frames

    • One of low medium high extraHigh

    • framesFrameRange or null
      FrameRange fields
      • startinteger
      • endinteger
      • One of png jpeg tga

    • audioAudioTrack or null
      AudioTrack fields
      • pathstring
      • offsetSecondsnumber
    • One of queued rendering succeeded failed cancelled

    • errorApiError or null
      ApiError fields
      • codestring
      • messagestring
    • chargedSecondsinteger (int64)
    • refundedSecondsinteger (int64)
    • createdAtstring (date-time)
    • startedAtstring (date-time) or null
    • finishedAtstring (date-time) or null
    • outputRenderOutputDto or null
      RenderOutputDto fields
      • mp4Urlstring or null
      • hlsUrlstring or null
      • frameUrlsarray of string or null
      • expiresAtstring (date-time)
      • posterUrlstring or null
    • namestring or null
    • playbackPlaybackState or null

      One of preparing streaming complete

    • replacementsarray of Replacement or null

      The 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
      • layerstring
      • textstring or null
      • fontstring or null
      • pathstring or null
      • fileEditFile or null
        EditFile fields
        • pathstring
        • contentstring or null
        • contentBase64string or null
        • uploadIdstring (uuid) or null
        • fromVersionIdstring (uuid) or null
        • fromPathstring or null
      • fitMediaFit or null

        One of contain cover

    • codecVideoCodec or null

      One of h264 hevc av1

    • encodingRenderEncoding or null

      Encoder settings a render asks for; without them its quality level sets a variable bitrate.

      RenderEncoding fields
      • rateControlRateControl

        One of quality vbr cbr

      • bitrateKbpsinteger or null
      • maxBitrateKbpsinteger or null
      • keyframeIntervalSecondsnumber or null
      • h264ProfileH264Profile or null

        One of baseline main high

  • nextstring or null

Errors

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 429 Too Many Requests

application/json · ErrorResponse

  • ApiError fields
    • codestring
    • messagestring

Errors lists the error codes and says when to retry.