Video Generation
Video Function
Execute video-related functions like loading available voices.
POST
/
video
/
function
Video function
curl --request POST \
--url https://api.postiz.com/public/v1/video/function \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"functionName": "loadVoices",
"identifier": "image-text-slides"
}
'import requests
url = "https://api.postiz.com/public/v1/video/function"
payload = {
"functionName": "loadVoices",
"identifier": "image-text-slides"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({functionName: 'loadVoices', identifier: 'image-text-slides'})
};
fetch('https://api.postiz.com/public/v1/video/function', 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.postiz.com/public/v1/video/function",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'functionName' => 'loadVoices',
'identifier' => 'image-text-slides'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.postiz.com/public/v1/video/function"
payload := strings.NewReader("{\n \"functionName\": \"loadVoices\",\n \"identifier\": \"image-text-slides\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.postiz.com/public/v1/video/function")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"functionName\": \"loadVoices\",\n \"identifier\": \"image-text-slides\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.postiz.com/public/v1/video/function")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"functionName\": \"loadVoices\",\n \"identifier\": \"image-text-slides\"\n}"
response = http.request(request)
puts response.read_body{
"voices": [
{
"id": "<string>",
"name": "<string>"
}
]
}Get Available Voices
To get the list of available voices for video generation:{
"functionName": "loadVoices",
"identifier": "image-text-slides"
}
Authorizations
Your Postiz API key
Body
application/json
Response
200 - application/json
Function executed successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Video function
curl --request POST \
--url https://api.postiz.com/public/v1/video/function \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"functionName": "loadVoices",
"identifier": "image-text-slides"
}
'import requests
url = "https://api.postiz.com/public/v1/video/function"
payload = {
"functionName": "loadVoices",
"identifier": "image-text-slides"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({functionName: 'loadVoices', identifier: 'image-text-slides'})
};
fetch('https://api.postiz.com/public/v1/video/function', 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.postiz.com/public/v1/video/function",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'functionName' => 'loadVoices',
'identifier' => 'image-text-slides'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.postiz.com/public/v1/video/function"
payload := strings.NewReader("{\n \"functionName\": \"loadVoices\",\n \"identifier\": \"image-text-slides\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.postiz.com/public/v1/video/function")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"functionName\": \"loadVoices\",\n \"identifier\": \"image-text-slides\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.postiz.com/public/v1/video/function")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"functionName\": \"loadVoices\",\n \"identifier\": \"image-text-slides\"\n}"
response = http.request(request)
puts response.read_body{
"voices": [
{
"id": "<string>",
"name": "<string>"
}
]
}
