Get the transcript status of a campaign video
curl --request GET \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status"
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-api-secret': '<api-key>'}
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status', 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-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status",
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>",
"x-api-secret: <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-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<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-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"campaignId": "2qnbb3ki589oioyimq0o7t1dxkb402ux",
"status": "ready",
"language": "en",
"source": "master",
"generatedAt": "2026-09-16T10:00:00.000Z"
}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Missing authentication"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}{
"statusCode": 503,
"error": "Service Unavailable",
"message": "Service Unavailable"
}Transcription
Get the transcript status of a campaign video
Reports whether a campaign video has a transcript and whether it is ready to read. It never starts a transcription, so it is safe to poll, and a campaign that never had one returns none rather than an error.
GET
/
v1
/
workspaces
/
{workspaceId}
/
campaigns
/
{campaignId}
/
transcript
/
status
Get the transcript status of a campaign video
curl --request GET \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status"
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-api-secret': '<api-key>'}
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status', 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-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status",
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>",
"x-api-secret: <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-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<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-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/transcript/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"campaignId": "2qnbb3ki589oioyimq0o7t1dxkb402ux",
"status": "ready",
"language": "en",
"source": "master",
"generatedAt": "2026-09-16T10:00:00.000Z"
}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Missing authentication"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}{
"statusCode": 503,
"error": "Service Unavailable",
"message": "Service Unavailable"
}Path Parameters
The workspace the campaign belongs to. Retrieve it from GET /v1/workspaces/identifier.
Example:
"7voa5y6qjj04kkbfqbgjd7kdvxlf4gqo"
The campaign whose video transcript you want.
Example:
"2qnbb3ki589oioyimq0o7t1dxkb402ux"
Response
The current transcript status.
Example:
"2qnbb3ki589oioyimq0o7t1dxkb402ux"
none — no transcript was ever requested. processing — one is being produced. ready — it can be read. failed — generation did not succeed.
Available options:
none, processing, ready, failed Example:
"ready"
Example:
"en"
Available options:
master, prospect Example:
"master"
Example:
"2026-09-16T10:00:00.000Z"
Was this page helpful?