Skip to main content
GET
Get a campaign video transcript

Authorizations

x-api-key
string
header
required
x-api-secret
string
header
required

Path Parameters

workspaceId
string
required

The workspace the campaign belongs to. Retrieve it from GET /v1/workspaces/identifier.

Example:

"7voa5y6qjj04kkbfqbgjd7kdvxlf4gqo"

campaignId
string
required

The campaign whose video transcript you want.

Example:

"2qnbb3ki589oioyimq0o7t1dxkb402ux"

Query Parameters

format
enum<string>
default:json

The representation to return. json is the default. vtt returns a WebVTT file and srt a SubRip file, both sent as a download with a Content-Disposition header.

Available options:
json,
vtt,
srt

Response

The transcript, in the requested representation.

campaignId
string
Example:

"2qnbb3ki589oioyimq0o7t1dxkb402ux"

language
string

The language the transcript is stored under.

Example:

"en"

source
enum<string>

Which recording the transcript describes: master is the campaign's own video, prospect the personalized render made for one recipient.

Available options:
master,
prospect
Example:

"master"

generatedAt
string<date-time> | null

When the transcript was produced. Null for a prospect transcript, which is derived from the master.

Example:

"2026-09-16T10:00:00.000Z"

text
string

The whole transcript as plain text, one line per segment.

Example:

"Hi there, thanks for taking a look at this."

segments
object[]