YouTube Video
Metadata for one YouTube video or Short by URL or ID: title, description, channel, views, likes, comment count, duration, publish date, tags and category.
- Price per call
- 2 credits
- per successful call
- Price ceiling
- 8 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. videoAuth: 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 with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/youtube.video" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.youtube.com/watch?v=Y2Ah_DFr8cw"}'const res = await fetch('https://api.primaryapi.com/v1/run/youtube.video', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
url: 'https://www.youtube.com/watch?v=Y2Ah_DFr8cw',
}),
});
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",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"url": "https://www.youtube.com/watch?v=Y2Ah_DFr8cw",
},
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",
"input": {
"url": "https://www.youtube.com/watch?v=Y2Ah_DFr8cw"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/youtube.video" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.youtube.com/watch?v=Y2Ah_DFr8cw"}'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.
urlstring- YouTube video URL: watch, youtu.be, Shorts, live, embed and mobile links all work. Give url or id.max 2048 chars
idstring- 11-character YouTube video ID (a Short uses the same ID format). Give url or id.pattern: ^[A-Za-z0-9_-]{11}$
Output
When output.found is true, output.data has these fields.
idstring- 11-character video ID
urlstring- Canonical watch URL
titlestring | nulldescriptionstring | nullimagestring | null- Thumbnail URL
createdUtcstring | null- Publish time, ISO 8601
durationMsinteger | nullviewsinteger | nulllikesinteger | null- null when the creator hides likes
commentsinteger | null- Comment count; null when comments are off or the source does not expose it
categorystring | null- YouTube category (genre)
keywordsstring[] | null- Creator tags; null when the source does not expose them
channelstring | null- Channel title
authorIdstring | null- Channel ID (UC…)
authorUrlstring | nullauthorAvatarUrlstring | nullisPaidPromotionboolean | null- YouTube "includes paid promotion" flag (null when the source does not expose it)
TypeScript type
/** output.data when output.found is true */
type YoutubeVideo = {
/** 11-character video ID */
id: string;
/** Canonical watch URL */
url: string;
title: string | null;
description: string | null;
/** Thumbnail URL */
image: string | null;
/** Publish time, ISO 8601 */
createdUtc: string | null;
durationMs: number | null;
views: number | null;
/** null when the creator hides likes */
likes: number | null;
/** Comment count; null when comments are off or the source does not expose it */
comments: number | null;
/** YouTube category (genre) */
category: string | null;
/** Creator tags; null when the source does not expose them */
keywords: string[] | null;
/** Channel title */
channel: string | null;
/** Channel ID (UC…) */
authorId: string | null;
authorUrl: string | null;
authorAvatarUrl: string | null;
/** YouTube "includes paid promotion" flag (null when the source does not expose it) */
isPaidPromotion: boolean | 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": {
"id": "Y2Ah_DFr8cw",
"url": "https://www.youtube.com/watch?v=Y2Ah_DFr8cw",
"title": "Inside the NBA: Chuck Trolls Jussie Smollett \"Do not commit crimes with checks, use cash!\"",
"description": null,
"image": "https://img.youtube.com/vi/Y2Ah_DFr8cw/maxresdefault.jpg",
"createdUtc": "2019-02-22T11:19:54.000Z",
"durationMs": 348000,
"views": 372864,
"likes": 4043,
"comments": 358,
"category": "People & Blogs",
"keywords": [],
"channel": "Afroballer",
"authorId": "UCWH3hing1Qb4LnkRfQdxsxQ",
"authorUrl": "https://www.youtube.com/@afroballer8906",
"authorAvatarUrl": null,
"isPaidPromotion": false
}
},
"provider": "PrimaryAPI",
"credits": 2,
"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.
Notes
Callers pass url or id; vendors always receive the canonical watch URL.
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 Video Comments2 credits
- YouTube Video Transcript2 credits
- YouTube Video Transcript (Provenance)3 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.