Transcription

Get the transcript status of a campaign video

Changed on

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

Request

  • Base URL
    https://api-gw.sendspark.com
  • Auth
    API key in header x-api-key and API key in header x-api-secret

Path parameters

workspaceIdstring required
Example:7voa5y6qjj04kkbfqbgjd7kdvxlf4gqo

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

campaignIdstring required
Example:2qnbb3ki589oioyimq0o7t1dxkb402ux

The campaign whose video transcript you want.

Response

The current transcript status.

campaignIdstring
status'none' | 'processing' | 'ready' | 'failed'

none — no transcript was ever requested. processing — one is being produced. ready — it can be read. failed — generation did not succeed.

languagestring nullable
source'master' | 'prospect' nullable
generatedAtstring date-time nullable

Example response

{
  "campaignId": "2qnbb3ki589oioyimq0o7t1dxkb402ux",
  "status": "ready",
  "language": "en",
  "source": "master",
  "generatedAt": "2026-09-16T10:00:00.000Z"
}

Changes