cURL
curl --request GET \
--url 'https://api.bannerify.co/v1/videos/{id}?apiKey='import requests
url = "https://api.bannerify.co/v1/videos/{id}?apiKey="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.bannerify.co/v1/videos/{id}?apiKey=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bannerify.co/v1/videos/{id}?apiKey=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bannerify.co/v1/videos/{id}?apiKey="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bannerify.co/v1/videos/{id}?apiKey=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bannerify.co/v1/videos/{id}?apiKey=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "vid_0b3c1c1e5d6f4c529e0a8f6a4c0f2a11",
"status": "queued",
"url": "https://images.bannerify.co/files/0b3c1c1e-5d6f-4c52-9e0a-8f6a4c0f2a11.mp4",
"error": "<string>"
}{
"error": {
"code": "BAD_REQUEST",
"docs": "https://bannerify.co/docs/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req:1234"
}
}{
"error": {
"code": "NOT_FOUND",
"docs": "https://bannerify.co/docs/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req:1234"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://bannerify.co/docs/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req:1234"
}
}API Documentation
Retrieve a video
The videos endpoint returns the status and the URL of a video by its id, or streams its progress again.
GET
/
v1
/
videos
/
{id}
cURL
curl --request GET \
--url 'https://api.bannerify.co/v1/videos/{id}?apiKey='import requests
url = "https://api.bannerify.co/v1/videos/{id}?apiKey="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.bannerify.co/v1/videos/{id}?apiKey=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bannerify.co/v1/videos/{id}?apiKey=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bannerify.co/v1/videos/{id}?apiKey="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.bannerify.co/v1/videos/{id}?apiKey=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bannerify.co/v1/videos/{id}?apiKey=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "vid_0b3c1c1e5d6f4c529e0a8f6a4c0f2a11",
"status": "queued",
"url": "https://images.bannerify.co/files/0b3c1c1e-5d6f-4c52-9e0a-8f6a4c0f2a11.mp4",
"error": "<string>"
}{
"error": {
"code": "BAD_REQUEST",
"docs": "https://bannerify.co/docs/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req:1234"
}
}{
"error": {
"code": "NOT_FOUND",
"docs": "https://bannerify.co/docs/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req:1234"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://bannerify.co/docs/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req:1234"
}
}Authorizations
Path Parameters
The id of the video, from renderVideo.
Query Parameters
Your API key. Create one on the API Keys page of the dashboard, and keep it on the server.
Example:
"YOUR_API_KEY"
true streams the events of the video as server-sent events.
Example:
"true"
Response
The video, or its events.
Example:
"vid_0b3c1c1e5d6f4c529e0a8f6a4c0f2a11"
queued while the video waits for a renderer, rendering while its frames render, then done or failed.
Available options:
queued, rendering, done, failed The public URL of the MP4, once the video is done.
Example:
"https://images.bannerify.co/files/0b3c1c1e-5d6f-4c52-9e0a-8f6a4c0f2a11.mp4"
Why the video failed.