This endpoint retrieves a list of videos related to a specified video, in the same order the provider ranks them. The source video is never included in the results, and duplicates across pages are removed.Each page returns up to 20 videos. Use the pages parameter to request more, up to a maximum of 10 pages.
This endpoint is backed by Poix’s related-videos provider rather than the
YouTube Data API, so it consumes no YouTube quota units.
Price
The cost of this request is $0.00003 per request plus $0.0005 per page fetched:
pages
Total cost
1 (default)
$0.00053
5
$0.00253
10
$0.00503
Only pages that are actually fetched are billed. If the provider runs out of results before reaching the number of pages you requested, you are charged for the pages that were fetched — the pagesFetched field in the response tells you exactly how many that was.
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
videoId
string
required
The ID of the video to retrieve related videos for.
Minimum string length: 1
pages
string
default:1
The number of provider pages to fetch, each returning up to 20 videos. Between 1 and 10. Each page that is actually fetched is billed; if the provider runs out of results early, only the pages that were fetched are charged.
regionCode
enum<string>
Instructs the API to return results as if the request was made from a specific country. The parameter value is an ISO 3166-1 alpha-2 country code.
Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AN,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BM,
BN,
BO,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
EU,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
ST,
SV,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XK,
YE,
YT,
ZA,
ZM,
ZW
hl
enum<string>
The language to retrieve localized data in.
Available options:
en,
es,
de,
fr,
ja,
pt,
tr,
it,
fa,
nl,
af,
am,
ar,
as,
az,
be,
bg,
bn,
bs,
ca,
cs,
da,
el,
en-GB,
en-IN,
es-419,
es-US,
et,
eu,
fi,
fil,
fr-CA,
gl,
gu,
hi,
hr,
hu,
hy,
id,
is,
iw,
ka,
kk,
km,
kn,
ko,
ky,
lo,
lt,
lv,
mk,
ml,
mn,
mr,
ms,
my,
no,
ne,
or,
pa,
pl,
pt-PT,
ro,
ru,
si,
sk,
sl,
sq,
sr-Latn,
sr,
sv,
sw,
ta,
te,
th,
uk,
ur,
uz,
vi,
zh-CN,
zh-HK,
zh-TW,
zh-Hans,
zu
Response
Successful response
totalResults
number
required
Total number of related videos returned.
pagesFetched
number
required
The number of provider pages actually fetched for this request. This is what the request was billed for, and it can be lower than the requested pages when the provider has no further results.
data
object[]
required
Array of related video objects.
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Poix API Documentation","colors":{"primary":"#6466f1","light":"#6466f1","dark":"#6466f1"},"favicon":"https://mintcdn.com/poix-a0bff09f/JfolOoh6sFUQi7Po/favicon.svg?fit=max\u0026auto=format\u0026n=JfolOoh6sFUQi7Po\u0026q=85\u0026s=eea5681c198bb6e73d5d0ff0491d32df","logo":{"light":"https://mintcdn.com/poix-a0bff09f/JfolOoh6sFUQi7Po/logo/light.svg?fit=max\u0026auto=format\u0026n=JfolOoh6sFUQi7Po\u0026q=85\u0026s=1cb7d68fa1f403e4f0fd2da3c9d8208a","dark":"https://mintcdn.com/poix-a0bff09f/JfolOoh6sFUQi7Po/logo/dark.svg?fit=max\u0026auto=format\u0026n=JfolOoh6sFUQi7Po\u0026q=85\u0026s=c617486ea5cadcf67b09325543843a3c"},"api":{"openapi":"https://api.poix.io/openapi.json"},"navbar":{"links":[{"label":"Support","href":"mailto:support@poix.io"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.poix.io"}},"integrations":{"ga4":{"measurementId":"G-JYWLQXM0PW"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","href":"https://app.poix.io","icon":"grid"},{"anchor":"Pricing","href":"https://poix.io/pricing","icon":"circle-dollar"},{"anchor":"Contact","href":"https://poix.io/contact","icon":"envelope"},{"anchor":"Status","href":"https://status.poix.io","icon":"circle-check"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"poix-a0bff09f","hasAudioNarration":false,"actualSubdomain":"poix-a0bff09f","customDomains":["docs.poix.io"],"gitSource":{"type":"github","owner":"poixio","repo":"poixio-docs-app","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6a88a547bea33c0ce616f090","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":23},{"language":"default","tag":"MCP","count":11},{"language":"default","tag":"Search","count":8},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Client Setup","count":8},{"language":"default","tag":"API Documentation","count":7},{"language":"default","tag":"Documentation","count":7},{"language":"default","tag":"Internal API","count":7},{"language":"default","tag":"Batch","count":4},{"language":"default","tag":"Files","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/videos/get-related-videos","slug":"/api-reference/videos/get-related-videos","pageMetadata":{"title":"Get related videos","openapi":"get /relatedVideos","description":"This endpoint retrieves a list of videos related to a specified video.","href":"/api-reference/videos/get-related-videos"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This endpoint retrieves a list of videos related to a specified video.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This endpoint retrieves a list of videos related to a specified video, in the same order the provider ranks them. The source video is never included in the results, and duplicates across pages are removed.`}),`\n`,_jsxs(_components.p,{children:[`Each page returns up to 20 videos. Use the `,_jsx(_components.code,{children:`pages`}),` parameter to request more, up to a maximum of 10 pages.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`This endpoint is backed by Poix’s related-videos provider rather than the\nYouTube Data API, so it consumes `,_jsx(_components.strong,{children:`no YouTube quota units`}),`.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`price`,children:`Price`}),`\n`,_jsx(_components.p,{children:`The cost of this request is $0.00003 per request plus $0.0005 per page fetched:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`pages`})}),_jsx(_components.th,{children:`Total cost`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`1 (default)`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`$0.00053`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`5`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`$0.00253`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`10`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`$0.00503`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Only pages that are actually fetched are billed. If the provider runs out of results before reaching the number of pages you requested, you are charged for the pages that were fetched — the `,_jsx(_components.code,{children:`pagesFetched`}),` field in the response tells you exactly how many that was.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get related videos","openapi":"get /relatedVideos","description":"This endpoint retrieves a list of videos related to a specified video.","href":"/api-reference/videos/get-related-videos"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Price","slug":"price","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get related videos","operationId":"getRelatedVideos","description":"This endpoint retrieves a list of videos related to a specified video.","tags":["Search"],"security":["38fd42ed-6ea1-443a-a767-0e2373623f0e"],"parameters":["a348bdb5-54d9-4e6c-8d05-5223ae9b7294","183c8fe7-5593-4a46-8a03-e24d1c09cf0e","dfc72626-5597-4727-b89e-5ae023f3162e","d8fc414c-ee4f-42c0-a169-55923ecb555c"],"responses":{"200":"98f7405e-51ce-4ff6-8835-b9f53dc8b48a","400":"d41ae1c9-9aad-4240-9b6f-108e34c64c4c","403":"99d31fb6-912a-4fc7-9c74-b32545132461"},"method":"get","type":"path","servers":["52ddbf38-c62c-4954-916a-7ae2e0c773b1"],"path":"/relatedVideos","baseUrlOptions":["https://api.poix.io"],"title":"Get related videos","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a348bdb5-54d9-4e6c-8d05-5223ae9b7294":{"schema":{"type":"string","minLength":1,"description":"The ID of the video to retrieve related videos for.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"The ID of the video to retrieve related videos for.","name":"videoId","in":"query"},"183c8fe7-5593-4a46-8a03-e24d1c09cf0e":{"schema":{"type":"string","default":"1","description":"The number of provider pages to fetch, each returning up to 20 videos. Between 1 and 10. Each page that is actually fetched is billed; if the provider runs out of results early, only the pages that were fetched are charged.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"The number of provider pages to fetch, each returning up to 20 videos. Between 1 and 10. Each page that is actually fetched is billed; if the provider runs out of results early, only the pages that were fetched are charged.","name":"pages","in":"query"},"dfc72626-5597-4727-b89e-5ae023f3162e":{"schema":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BM","BN","BO","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","EU","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","ST","SV","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Instructs the API to return results as if the request was made from a specific country. The parameter value is an ISO 3166-1 alpha-2 country code.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Instructs the API to return results as if the request was made from a specific country. The parameter value is an ISO 3166-1 alpha-2 country code.","name":"regionCode","in":"query"},"d8fc414c-ee4f-42c0-a169-55923ecb555c":{"schema":{"type":"string","enum":["en","es","de","fr","ja","pt","tr","it","fa","nl","af","am","ar","as","az","be","bg","bn","bs","ca","cs","da","el","en-GB","en-IN","es-419","es-US","et","eu","fi","fil","fr-CA","gl","gu","hi","hr","hu","hy","id","is","iw","ka","kk","km","kn","ko","ky","lo","lt","lv","mk","ml","mn","mr","ms","my","no","ne","or","pa","pl","pt-PT","ro","ru","si","sk","sl","sq","sr-Latn","sr","sv","sw","ta","te","th","uk","ur","uz","vi","zh-CN","zh-HK","zh-TW","zh-Hans","zu"],"description":"The language to retrieve localized data in.","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"The language to retrieve localized data in.","name":"hl","in":"query"}},"responses":{"98f7405e-51ce-4ff6-8835-b9f53dc8b48a":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"totalResults":{"type":"number","description":"Total number of related videos returned.","isRequired":true,"uniqueKey":"totalResults","typeLabel":"number"},"pagesFetched":{"type":"number","description":"The number of provider pages actually fetched for this request. This is what the request was billed for, and it can be lower than the requested `pages` when the provider has no further results.","isRequired":true,"uniqueKey":"pagesFetched","typeLabel":"number"},"data":{"type":"array","items":{"type":"object","properties":{"videoId":{"type":"string","description":"The ID of the related video.","isRequired":true,"uniqueKey":"data.items.[INDEX].videoId","typeLabel":"string"},"title":{"type":"string","description":"The title of the related video.","isRequired":true,"uniqueKey":"data.items.[INDEX].title","typeLabel":"string"},"viewCount":{"type":"number","description":"The number of views the video has.","isRequired":true,"uniqueKey":"data.items.[INDEX].viewCount","typeLabel":"number"},"publishedAt":{"type":"string","description":"The date the video was published, in ISO 8601 format. The provider reports day precision, so the time component is always midnight UTC.","isRequired":true,"uniqueKey":"data.items.[INDEX].publishedAt","typeLabel":"string"},"channelId":{"type":"string","description":"The ID of the channel that published the video. Omitted when the provider does not expose channel details for this video.","uniqueKey":"data.items.[INDEX].channelId","typeLabel":"string"},"channelHandle":{"type":"string","description":"The handle of the channel that published the video, including the leading \"@\".","uniqueKey":"data.items.[INDEX].channelHandle","typeLabel":"string"},"channelTitle":{"type":"string","description":"The title of the channel that published the video.","uniqueKey":"data.items.[INDEX].channelTitle","typeLabel":"string"}},"required":["videoId","title","viewCount","publishedAt"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"Array of related video objects.","isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"required":["totalResults","pagesFetched","data"],"uniqueKey":"","typeLabel":"object"},"example":{"totalResults":3,"pagesFetched":1,"data":[{"videoId":"3ix8kNGRwxE","title":"The Lord Of The Rings | When Hope Moves In Silence — Emotional Deep Focus","channelId":"UCyPNg3TV04kk4FF5laSoROA","channelHandle":"@CinematicSoulChannel","channelTitle":"CinematicSoul","viewCount":698000,"publishedAt":"2026-01-17T00:00:00Z"},{"videoId":"t-yD25Kbv6c","title":"Read with Aragorn in Rivendell 🌿 | LOTR Ambient Music for Peace, Focus \u0026 Reflection","channelId":"UCBGbmFOOYnXWTIWzsJNADbQ","channelHandle":"@QuietHourAmbience","channelTitle":"The Quiet Hour","viewCount":348000,"publishedAt":"2026-01-17T00:00:00Z"},{"videoId":"B5Lfey8nBYM","title":"Well... now I understand why he's the perfect Aragorn","viewCount":230000,"publishedAt":"2026-07-17T00:00:00Z"}]},"examples":{"Example":{"title":"Example","value":{"totalResults":3,"pagesFetched":1,"data":[{"videoId":"3ix8kNGRwxE","title":"The Lord Of The Rings | When Hope Moves In Silence — Emotional Deep Focus","channelId":"UCyPNg3TV04kk4FF5laSoROA","channelHandle":"@CinematicSoulChannel","channelTitle":"CinematicSoul","viewCount":698000,"publishedAt":"2026-01-17T00:00:00Z"},{"videoId":"t-yD25Kbv6c","title":"Read with Aragorn in Rivendell 🌿 | LOTR Ambient Music for Peace, Focus \u0026 Reflection","channelId":"UCBGbmFOOYnXWTIWzsJNADbQ","channelHandle":"@QuietHourAmbience","channelTitle":"The Quiet Hour","viewCount":348000,"publishedAt":"2026-01-17T00:00:00Z"},{"videoId":"B5Lfey8nBYM","title":"Well... now I understand why he's the perfect Aragorn","viewCount":230000,"publishedAt":"2026-07-17T00:00:00Z"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d41ae1c9-9aad-4240-9b6f-108e34c64c4c":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"issues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.issues.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"type":"string","uniqueKey":"error.issues.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"error.issues.items.[INDEX].path","typeLabel":"string[]"},"expected":{"type":"string","uniqueKey":"error.issues.items.[INDEX].expected","typeLabel":"string"},"received":{"type":"string","uniqueKey":"error.issues.items.[INDEX].received","typeLabel":"string"},"maximum":{"type":"number","uniqueKey":"error.issues.items.[INDEX].maximum","typeLabel":"number"},"type":{"type":"string","uniqueKey":"error.issues.items.[INDEX].type","typeLabel":"string"},"inclusive":{"type":"boolean","uniqueKey":"error.issues.items.[INDEX].inclusive","typeLabel":"boolean"},"exact":{"type":"boolean","uniqueKey":"error.issues.items.[INDEX].exact","typeLabel":"boolean"}},"required":["code","message","path"],"uniqueKey":"error.issues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.issues","typeLabel":"object[]"},"name":{"type":"string","enum":["ZodError"],"isRequired":true,"uniqueKey":"error.name","typeLabel":"enum\u003cstring>"}},"required":["issues","name"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"issues":[{"code":"invalid_type","expected":"string","received":"undefined","path":["videoId"],"message":"Required"}],"name":"ZodError"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"issues":[{"code":"invalid_type","expected":"string","received":"undefined","path":["videoId"],"message":"Required"}],"name":"ZodError"}}}},"exampleType":"examples"}},"exampleType":"examples"},"99d31fb6-912a-4fc7-9c74-b32545132461":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Forbidden"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Forbidden"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"38fd42ed-6ea1-443a-a767-0e2373623f0e":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"52ddbf38-c62c-4954-916a-7ae2e0c773b1":{"url":"https://api.poix.io","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"https://api.poix.io/openapi.json"},"subdomain":"poix-a0bff09f","siteName":"Poix API Documentation","title":"Get related videos - Poix API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-17T20:51:12.091Z","originalFileLocation":"api-reference/videos/get-related-videos.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint retrieves a list of videos related to a specified video.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Poix API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get related videos - Poix API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint retrieves a list of videos related to a specified video.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Poix API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.poix.io/api-reference/videos/get-related-videos\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://poix-a0bff09f.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Get+related+videos\u0026amp;description=This+endpoint+retrieves+a+list+of+videos+related+to+a+specified+video.\u0026amp;theme=657d1a710259afafebbb1a0f\u0026amp;signature=884bff8f8d760e8960e4e7cf666056cbeb7b5da2a9c3d8457d177c58445e9a82\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get related videos - Poix API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint retrieves a list of videos related to a specified video.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://poix-a0bff09f.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Get+related+videos\u0026amp;description=This+endpoint+retrieves+a+list+of+videos+related+to+a+specified+video.\u0026amp;theme=657d1a710259afafebbb1a0f\u0026amp;signature=884bff8f8d760e8960e4e7cf666056cbeb7b5da2a9c3d8457d177c58445e9a82\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/poix-a0bff09f/FVJL5dWnKYKspYeR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Poix API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6466f1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.poix.io/api-reference/videos/get-related-videos\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/videos/get-related-videos.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.poix.io/#organization\",\"name\":\"Poix API Documentation\",\"url\":\"https://docs.poix.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/poix-a0bff09f/JfolOoh6sFUQi7Po/logo/light.svg?fit=max\u0026auto=format\u0026n=JfolOoh6sFUQi7Po\u0026q=85\u0026s=1cb7d68fa1f403e4f0fd2da3c9d8208a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.poix.io#website\",\"name\":\"Poix API Documentation\",\"url\":\"https://docs.poix.io\",\"publisher\":{\"@id\":\"https://docs.poix.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.poix.io/api-reference/videos/get-related-videos#webpage\",\"url\":\"https://docs.poix.io/api-reference/videos/get-related-videos\",\"name\":\"Get related videos\",\"description\":\"This endpoint retrieves a list of videos related to a specified video.\",\"dateModified\":\"2026-08-17T20:51:12.091Z\",\"isPartOf\":{\"@id\":\"https://docs.poix.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.poix.io/api-reference/videos/get-related-videos#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.poix.io/api-reference/videos/get-related-videos#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Search\",\"item\":\"https://docs.poix.io/api-reference/search/get-search-results\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get related videos\",\"item\":\"https://docs.poix.io/api-reference/videos/get-related-videos\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.poix.io/api-reference/videos/get-related-videos#apireference\",\"headline\":\"Get related videos\",\"name\":\"Get related videos\",\"description\":\"This endpoint retrieves a list of videos related to a specified video.\",\"url\":\"https://docs.poix.io/api-reference/videos/get-related-videos\",\"mainEntityOfPage\":{\"@id\":\"https://docs.poix.io/api-reference/videos/get-related-videos#webpage\"},\"dateModified\":\"2026-08-17T20:51:12.091Z\",\"publisher\":{\"@id\":\"https://docs.poix.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.poix.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Poix API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Poix API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/videos/get-related-videos.md","siteName":"Poix API Documentation","nav":{"global":{"anchors":[{"anchor":"Dashboard","href":"https://app.poix.io","icon":"grid"},{"anchor":"Pricing","href":"https://poix.io/pricing","icon":"circle-dollar"},{"anchor":"Contact","href":"https://poix.io/contact","icon":"envelope"},{"anchor":"Status","href":"https://status.poix.io","icon":"circle-check"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Tokens","href":"/api-reference/create-token"},{"title":"Languages","href":"/api-reference/languages"},{"title":"Categories","href":"/api-reference/categories"},{"title":"Countries","href":"/api-reference/countries"},{"title":"Topics","href":"/api-reference/topics"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Search","pages":[{"title":"Get search results","openapi":"get /search","href":"/api-reference/search/get-search-results"},{"title":"Get search suggestions","openapi":"get /autocomplete","href":"/api-reference/search/get-search-suggestions"},{"title":"Get popular videos","openapi":"get /popularVideos","description":"Get popular videos with filters","href":"/api-reference/videos/get-popular-videos"},{"title":"Get related videos","openapi":"get /relatedVideos","href":"/api-reference/videos/get-related-videos"}]},{"group":"Batch","pages":[{"title":"Get batch videos","openapi":"post /batch/videos","description":"Retrieve up to 1000 videos data based on IDs","href":"/api-reference/batch/get-batch-videos"},{"title":"Get batch channels","openapi":"post /batch/channels","href":"/api-reference/batch/get-batch-channels"}]},{"group":"Details","pages":[{"title":"Get channels details","openapi":"get /channels","href":"/api-reference/channels/get-channels-details"},{"title":"Get videos details","openapi":"get /videos","href":"/api-reference/videos/get-videos-details"},{"title":"Get playlist items","openapi":"get /playlistItems","href":"/api-reference/playlist/get-playlist-items"}]},{"group":"General","pages":[{"title":"Get video captions","openapi":"get /captions/{videoId}","href":"/api-reference/captions/get-video-captions"},{"title":"Get comment threads","openapi":"get /commentThreads","href":"/api-reference/comments/get-video-comment-threads"},{"title":"Get comment replies","openapi":"get /commentReplies","href":"/api-reference/comments/get-video-comment-replies"}]},{"group":"Files","pages":[{"title":"Get audio files list","openapi":"get /files/audio/{videoId}","href":"/api-reference/files/get-audio-files-list"},{"title":"Get video files list","openapi":"get /files/video/{videoId}","href":"/api-reference/files/get-video-files-list"},{"title":"Get captions files list","openapi":"get /files/captions/{videoId}","href":"/api-reference/files/get-captions-files-list"},{"title":"Get thumbnails files list","openapi":"get /files/thumbnails/{videoId}","href":"/api-reference/files/get-thumbnails-files-list"}]}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/search/search-by-keyword"}]},{"tab":"Internal API","pages":[{"title":"Internal API","href":"/internal-api/authentication"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Get related videos - Poix API Documentation","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}