Create a download archive
POST/v1/renders/download-archive
Queues one ZIP of up to 1,000 succeeded MP4 or HLS renders, each under its download file name. Get the archive until its status is ready for the download URL. Archives are kept for 24 hours. At most 10 archives per workspace wait or build at once (409 archive_limit).
Request
curl -s -X POST $BLITFRAME/renders/download-archive \
-H "Authorization: Bearer $BLITFRAME_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"],
"name": "Summer campaign"
}'
import os, requests
response = requests.post(
f"{os.environ['BLITFRAME']}/renders/download-archive",
headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
json={
"renderIds": ["0f8e6d4c-2b1a-4c3d-9e8f-7a6b5c4d3e2f", "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d"],
"name": "Summer campaign",
},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/renders/download-archive`, {
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"],
name: "Summer campaign",
}),
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/renders/download-archive");
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"],
"name": "Summer campaign"
}',
]);
$response = curl_exec($request);
echo $response;
require "net/http"
uri = URI(ENV["BLITFRAME"] + '/renders/download-archive')
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"],
"name": "Summer campaign"
}'
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"],
"name": "Summer campaign"
}`)
request, err := http.NewRequest("POST", os.Getenv("BLITFRAME")+"/renders/download-archive", 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/download-archive");
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"],
"name": "Summer campaign"
}
""", 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/download-archive"))
.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"],
"name": "Summer campaign"
}
"""))
.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 · CreateRenderArchiveRequest
renderIdsarray of string (uuid) or nullrequirednamestring or null
Responses
- 202 Accepted
application/json · RenderArchiveDto
idstring (uuid)statusRenderArchiveStatusOne of
queuedbuildingreadyfailedrenderIdsarray of string (uuid)fileNamestringurlstring or nullsizeBytesinteger (int64) or nullerrorApiError or nullApiError fields
codestringmessagestring
createdAtstring (date-time)finishedAtstring (date-time) or nullexpiresAtstring (date-time)
Errors
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 409 Conflict
- 429 Too Many Requests
application/json · ErrorResponse
errorApiErrorApiError fields
codestringmessagestring
Errors lists the error codes and says when to retry.