YouTube Video Transcript (Provenance)
Transcript of a YouTube video or Short with timed segments, whether the captions are creator-written or speech recognition, and the video metadata in one response.
- Price per call
- 3 credits
- per successful call
- Price ceiling
- 7 credits
- if a call is retried elsewhere
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ youtube. video_transcript_fullAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/youtube.video_transcript_full with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/youtube.video_transcript_full" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.youtube.com/watch?v=p8gV_7zFN44"}'const res = await fetch('https://api.primaryapi.com/v1/run/youtube.video_transcript_full', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
url: 'https://www.youtube.com/watch?v=p8gV_7zFN44',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/youtube.video_transcript_full",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"url": "https://www.youtube.com/watch?v=p8gV_7zFN44",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "youtube.video_transcript_full",
"input": {
"url": "https://www.youtube.com/watch?v=p8gV_7zFN44"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/youtube.video_transcript_full" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.youtube.com/watch?v=p8gV_7zFN44"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
urlstringrequired- YouTube video or Short URL, e.g. https://www.youtube.com/watch?v=dQw4w9WgXcQ or https://www.youtube.com/shorts/Fir1x9cw2vg.max 2048 chars
captionKindenumdefault"any"- Which caption track to accept: manual (creator-written only), automatic (speech recognition only) or any.one of: manual, automatic, any
languagestring- Preferred caption language code such as "en" or "es". Omit for the default track.pattern: ^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})?$
Output
When output.found is true, output.data has these fields.
videoIdstring- 11-character video ID
urlstring- Canonical watch URL
titlestring | nulldescriptionstring | nullimagestring | null- Thumbnail URL
channelstring | null- Channel title
authorIdstring | null- Channel ID (UC…)
authorUrlstring | nullcategorystring | null- YouTube category
keywordsstring[] | null- Creator tags
likesinteger | nullviewsinteger | nullcreatedUtcstring | null- Publish time (or date), ISO 8601
durationSecondsnumber | null- Video length in seconds
languagestring | null- Language of the returned caption track (code, or a name when the source only gives one)
isAutoGeneratedboolean | null- true = YouTube speech recognition (ASR), false = creator-written captions, null = the source could not tell
transcriptstring- Full transcript text
segmentsobject[]- Timed caption segments
segments[].textstringsegments[].startSecondsnumber | nullsegments[].endSecondsnumber | null
TypeScript type
/** output.data when output.found is true */
type YoutubeVideoTranscriptFull = {
/** 11-character video ID */
videoId: string;
/** Canonical watch URL */
url: string;
title: string | null;
description: string | null;
/** Thumbnail URL */
image: string | null;
/** Channel title */
channel: string | null;
/** Channel ID (UC…) */
authorId: string | null;
authorUrl: string | null;
/** YouTube category */
category: string | null;
/** Creator tags */
keywords: string[] | null;
likes: number | null;
views: number | null;
/** Publish time (or date), ISO 8601 */
createdUtc: string | null;
/** Video length in seconds */
durationSeconds: number | null;
/** Language of the returned caption track (code, or a name when the source only gives one) */
language: string | null;
/** true = YouTube speech recognition (ASR), false = creator-written captions, null = the source could not tell */
isAutoGenerated: boolean | null;
/** Full transcript text */
transcript: string;
/** Timed caption segments */
segments: {
text: string;
startSeconds: number | null;
endSeconds: number | null;
}[];
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"videoId": "p8gV_7zFN44",
"url": "https://www.youtube.com/watch?v=p8gV_7zFN44",
"title": "Some video title",
"description": null,
"image": "https://i.ytimg.com/vi/p8gV_7zFN44/hqdefault.jpg",
"channel": "Some Channel",
"authorId": "UCxxxxxxxxxxxxxxxxxxxxxx",
"authorUrl": "https://www.youtube.com/channel/UCxxxxxxxxxxxxxxxxxxxxxx",
"category": "Education",
"keywords": [
"education",
"tutorial"
],
"likes": 234567,
"views": 12345678,
"createdUtc": "2024-05-12T00:00:00.000Z",
"durationSeconds": 4783,
"language": "en",
"isAutoGenerated": false,
"transcript": "Hello and welcome to this video...",
"segments": [
{
"text": "Hello and welcome to this video",
"startSeconds": 0.08,
"endSeconds": 3.58
}
]
}
},
"provider": "PrimaryAPI",
"credits": 3,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
More YouTube endpoints
- YouTube Channel1 credit
- YouTube Channel Live Streams2 credits
- YouTube Channel Public Email1 credit
- YouTube Channel Search2 credits
- YouTube Channel Shorts2 credits
- YouTube Channel Videos1 credit
- YouTube Hashtag Search2 credits
- YouTube Search2 credits
- YouTube Shorts Search2 credits
- YouTube Video2 credits
- YouTube Video Comments2 credits
- YouTube Video Transcript2 credits
- YouTube Channel Community PostsPlanned
- YouTube Channel Contact EmailPlanned
- YouTube Channel PlaylistsPlanned
- YouTube Comment RepliesPlanned
- YouTube Community PostPlanned
- YouTube PlaylistPlanned
- YouTube Trending ShortsPlanned
- YouTube Video SponsorsPlanned
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/youtube.video_transcript_full.