StatusSupportGet API keyDashboard
SchemasTranscripts

Schemas

Transcript

Use with AI

Timed transcripts of public videos: the platform's caption track, or speech-to-text on the audio when there is none.

Endpoints

9 endpoints return transcripts on Facebook Ad Library, Facebook, Instagram, Kick, Reddit, Rumble, TikTok, Twitch and YouTube.

Schema

Every endpoint above returns this object as data. The standard meta comes with every response.

platformstring

Platform the media is hosted on.

idstring

Platform-native ID of the post (equals post.id); of an ad library entry, its library ID (equals ad.id).

urlstring uri

Canonical URL of the post (of an ad library entry, its library page).

languagestringnullable

BCP-47 language of the returned transcript; null when unknown.

sourcestring

captions = platform caption track; asr = speech-to-text on the audio. New values may be added.

One ofcaptionsasr

is_auto_generatedboolean

True when the track was machine-generated (platform auto-captions or ASR).

available_languagesstring[]

BCP-47 caption languages the platform offers for this post; [] if none or not listed.

duration_msintegernullable

Media duration in milliseconds; null when unknown.

segmentsobject[]

Timed cues in order; never empty on success.

ShowHide 3 child fields
start_msinteger

Start time in milliseconds from the beginning of the media.

end_msinteger

End time in milliseconds from the beginning of the media.

textstring

Cue text, whitespace-normalized.

textstring

Full transcript: segment texts joined with single spaces.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 2 child fields
redditobjectnullable

A Reddit transcript's own fields.

ShowHide 2 child fields
video_idstringnullable

The video's ID on Reddit's video host (v.redd.it/<video_id>); null when unknown.

caption_urlstring urinullable

The WebVTT file of Reddit's caption track used (public, unsigned); null for speech-to-text.

rumbleobjectnullable

A Rumble transcript's own fields.

ShowHide 3 child fields
track_labelstringnullable

Rumble's label of the caption track used ("English (auto)"); null for speech-to-text.

caption_urlstring urinullable

The WebVTT file of the caption track used; null for speech-to-text.

caption_tracksobject[]

Every caption track Rumble offers for the video (WebVTT); [] when none.

ShowHide 4 child fields
languagestringnullable

Language code (en, es, …).

labelstringnullable

Rumble's label ("English (auto)").

urlstring urinullable

WebVTT file URL.

is_auto_generatedbooleannullable

Generated by Rumble's speech recognition.

Item errors

Besides the request-level errors every endpoint can return, transcript endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).Check the link or ID. Do not retry.
private_or_unavailable403NoThe item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.Only public items can be fetched. Do not retry.
no_transcript404NoThe video or audio exists but has no transcript: no caption track and no speech to transcribe.Do not retry. If the platform offers other languages, try one with lang.

Last updated