Get a video
curl --request GET \
--url https://api-eg.olimi.ai/api/v2/stv/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api-eg.olimi.ai/api/v2/stv/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api-eg.olimi.ai/api/v2/stv/{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://api-eg.olimi.ai/api/v2/stv/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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-eg.olimi.ai/api/v2/stv/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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-eg.olimi.ai/api/v2/stv/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/stv/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "STV job retrieved successfully",
"data": {
"id": "7a3e9c12-5d8b-4f61-a2c7-9e0b3d6f1a48",
"name": "Welcome message",
"status": "completed",
"progress": "1.00",
"configId": "4f0cda01-bd22-410c-8b2e-026ce07691da",
"errorCode": null,
"errorMessage": null,
"width": 512,
"height": 512,
"audioDuration": "6.42",
"videoDuration": "6.40",
"audioAttachmentId": "b1c9e4d2-7f3a-4e85-9b60-2d8f5a1c7e39",
"videoAttachmentId": "e6d2a8f1-3c9b-4a57-8e14-7b0c5f2d9a63",
"audioAttachment": {
"id": "b1c9e4d2-7f3a-4e85-9b60-2d8f5a1c7e39",
"originalName": "welcome.mp3",
"mimeType": "audio/mpeg"
},
"videoAttachment": {
"id": "e6d2a8f1-3c9b-4a57-8e14-7b0c5f2d9a63",
"originalName": "job_8f2c.mp4",
"mimeType": "video/mp4",
"url": "https://<storage-host>/stv/video_e6d2a8f1?X-Amz-Expires=3600&X-Amz-Signature=…"
},
"createdAt": "2026-09-29T10:02:11.904Z",
"updatedAt": "2026-09-29T10:03:48.310Z"
}
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 404,
"errorCode": "stv_job_not_found",
"message": "Speech-to-video job not found"
}Speech to Video
Get a video
Returns one video, with a download link once it’s ready.
GET
/
api
/
v2
/
stv
/
{id}
Get a video
curl --request GET \
--url https://api-eg.olimi.ai/api/v2/stv/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api-eg.olimi.ai/api/v2/stv/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api-eg.olimi.ai/api/v2/stv/{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://api-eg.olimi.ai/api/v2/stv/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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-eg.olimi.ai/api/v2/stv/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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-eg.olimi.ai/api/v2/stv/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/stv/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "STV job retrieved successfully",
"data": {
"id": "7a3e9c12-5d8b-4f61-a2c7-9e0b3d6f1a48",
"name": "Welcome message",
"status": "completed",
"progress": "1.00",
"configId": "4f0cda01-bd22-410c-8b2e-026ce07691da",
"errorCode": null,
"errorMessage": null,
"width": 512,
"height": 512,
"audioDuration": "6.42",
"videoDuration": "6.40",
"audioAttachmentId": "b1c9e4d2-7f3a-4e85-9b60-2d8f5a1c7e39",
"videoAttachmentId": "e6d2a8f1-3c9b-4a57-8e14-7b0c5f2d9a63",
"audioAttachment": {
"id": "b1c9e4d2-7f3a-4e85-9b60-2d8f5a1c7e39",
"originalName": "welcome.mp3",
"mimeType": "audio/mpeg"
},
"videoAttachment": {
"id": "e6d2a8f1-3c9b-4a57-8e14-7b0c5f2d9a63",
"originalName": "job_8f2c.mp4",
"mimeType": "video/mp4",
"url": "https://<storage-host>/stv/video_e6d2a8f1?X-Amz-Expires=3600&X-Amz-Signature=…"
},
"createdAt": "2026-09-29T10:02:11.904Z",
"updatedAt": "2026-09-29T10:03:48.310Z"
}
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 404,
"errorCode": "stv_job_not_found",
"message": "Speech-to-video job not found"
}The video has the fields described in Video fields. Once it’s
completed, videoAttachment.url is a temporary download link, valid for up to one hour.
For polling, Get video progress is lighter.