Cancel Render
curl --request DELETE \
--url https://apis.viggle.ai/v1/renders/{render_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/v1/renders/{render_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.viggle.ai/v1/renders/{render_id}', 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://apis.viggle.ai/v1/renders/{render_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://apis.viggle.ai/v1/renders/{render_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://apis.viggle.ai/v1/renders/{render_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/v1/renders/{render_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyRenders
Cancel Render
Cancel a queued or processing Render.
DELETE
/
v1
/
renders
/
{render_id}
Cancel Render
curl --request DELETE \
--url https://apis.viggle.ai/v1/renders/{render_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/v1/renders/{render_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.viggle.ai/v1/renders/{render_id}', 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://apis.viggle.ai/v1/renders/{render_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://apis.viggle.ai/v1/renders/{render_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://apis.viggle.ai/v1/renders/{render_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/v1/renders/{render_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyDELETE /v1/renders/{render_id} cancels a Render owned by the current account. For a terminal Render, it returns its current state.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
render_id | string | Yes | Full public Render ID beginning with render_. |
Response parameters
Returns200 OK with a Render object.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | Yes | Render ID. |
status | string | Yes | Usually cancelled; may be an existing terminal status. |
progress | integer or null | Yes | Progress when available. |
stage | string or null | Yes | Processing stage when available. |
video_url | string or null | Yes | Output URL only if already ready. |
alpha_url | string or null | Yes | Alpha output URL when available. |
created_at | string or null | Yes | Creation timestamp. |
completed_at | string or null | Yes | Completion timestamp. |
error | object or null | Yes | Failure details when applicable. |
{"id":"render_789ghi","status":"cancelled","progress":null,"stage":null,"video_url":null,"alpha_url":null,"created_at":null,"completed_at":null,"error":null}
Examples
req,_:=http.NewRequest("DELETE","https://apis.viggle.ai/v1/renders/render_789ghi",nil); req.Header.Set("Authorization","Bearer "+os.Getenv("VIGGLE_API_KEY")); resp,err:=http.DefaultClient.Do(req); if err!=nil { panic(err) }; defer resp.Body.Close()
const response=await fetch("https://apis.viggle.ai/v1/renders/render_789ghi",{method:"DELETE",headers:{Authorization:`Bearer ${process.env.VIGGLE_API_KEY}`}}); const render=await response.json();
import os, requests
response=requests.delete("https://apis.viggle.ai/v1/renders/render_789ghi",headers={"Authorization":f"Bearer {os.environ['VIGGLE_API_KEY']}"}); response.raise_for_status(); render=response.json()
curl -X DELETE "https://apis.viggle.ai/v1/renders/render_789ghi" -H "Authorization: Bearer $VIGGLE_API_KEY"
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200
Render
⌘I

