Export an HTML5 ad
GET/v1/renders/{renderId}/html
Packages a succeeded MP4 or HLS render for an ad network and returns a download URL. platform is generic unless named. adform, appLovin and unityAds require clickUrl, where a tap or click goes. interaction is video (the ad plays) or tapToContinue (it asks for a tap first); playable networks (appLovin, unityAds, googleAppCampaigns, meta, tikTok, pangle, mintegral, moloco, liftoff) require tapToContinue, their default. The whole ad must be under 5 MB; for theTradeDesk the video must be below 1.1 MB, or at most 2.2 MB with tapToContinue. Render at a lower quality for longer videos.
Request
curl -s $BLITFRAME/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html \
-H "Authorization: Bearer $BLITFRAME_API_KEY"
import os, requests
response = requests.get(
f"{os.environ['BLITFRAME']}/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html",
headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html`, {
headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}` },
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/renders/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html");
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/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html')
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/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html", 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/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html");
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/3a89d4b9-ce56-449b-ae51-5b6da964ef05/html"))
.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());
}
}
Path parameters
renderIdstring (uuid)required
Query parameters
platformHtmlAdPlatformOne of
genericgoogleCampaignManager360googleDisplayVideo360theTradeDeskadformappLovinunityAdsgoogleAppCampaignsmetatikTokpanglemintegralmolocoliftoffDefault
genericinteractionHtmlAdInteractionOne of
videotapToContinueclickUrlstring
Headers
AuthorizationBearer Blitframe API keyrequiredAPI key from the developer console.
Responses
- 200 OK
application/json · HtmlAdDto
urlstring
Errors
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 409 Conflict
- 413 Payload Too Large
- 429 Too Many Requests
- 503 Service Unavailable
application/json · ErrorResponse
errorApiErrorApiError fields
codestringmessagestring
Errors lists the error codes and says when to retry.