[{"data":1,"prerenderedAt":591},["ShallowReactive",2],{"doc-api\u002Fvideos":3},{"id":4,"title":5,"author":6,"body":7,"date":574,"description":575,"draft":576,"extension":577,"faq":578,"meta":579,"navigation":580,"path":581,"schemaType":582,"seo":583,"stem":584,"tags":585,"updatedAt":589,"__hash__":590},"content\u002Fapi\u002Fvideos.md","Videos","YT2Text Team",{"type":8,"value":9,"toc":563},"minimark",[10,15,24,29,69,74,77,304,307,338,342,368,373,380,385,388,440,445,447,483,493,498,501,509,514,517,520,536,541,544,552,559],[11,12,14],"h1",{"id":13},"videos-api","Videos API",[16,17,18,19,23],"p",{},"All video endpoints live under ",[20,21,22],"code",{},"\u002Fapi\u002Fv1\u002Fvideos",".",[25,26,28],"h2",{"id":27},"endpoints","Endpoints",[30,31,32,38,44,49,54,59,64],"ul",{},[33,34,35],"li",{},[20,36,37],{},"POST \u002Fapi\u002Fv1\u002Fvideos\u002Fprocess",[33,39,40,43],{},[20,41,42],{},"POST \u002Fapi\u002Fv1\u002Fvideos\u002Fprocess-sync"," admin-only",[33,45,46],{},[20,47,48],{},"GET \u002Fapi\u002Fv1\u002Fvideos\u002Fstatus\u002F{job_id}",[33,50,51],{},[20,52,53],{},"GET \u002Fapi\u002Fv1\u002Fvideos\u002Fresult\u002F{job_id}",[33,55,56],{},[20,57,58],{},"GET \u002Fapi\u002Fv1\u002Fvideos\u002Fexport\u002F{job_id}\u002Fpdf",[33,60,61],{},[20,62,63],{},"GET \u002Fapi\u002Fv1\u002Fvideos\u002F",[33,65,66],{},[20,67,68],{},"GET \u002Fapi\u002Fv1\u002Fvideos\u002Fthumbnails",[25,70,72],{"id":71},"post-apiv1videosprocess",[20,73,37],{},[16,75,76],{},"Request body:",[78,79,84],"pre",{"className":80,"code":81,"language":82,"meta":83,"style":83},"language-json shiki shiki-themes github-light github-dark","{\n  \"url\": \"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=dQw4w9WgXcQ\",\n  \"options\": {\n    \"max_transcript_length\": 10000000,\n    \"include_comments\": false,\n    \"language\": \"en\",\n    \"summary_modes\": [\"tldr\", \"detailed\"],\n    \"generate_infographic\": false\n  },\n  \"webhook_url\": \"https:\u002F\u002Fexample.com\u002Fwebhook\",\n  \"priority\": \"normal\",\n  \"custom_instructions\": \"Pro only\",\n  \"use_proxy\": null,\n  \"force_refresh\": false,\n  \"service_name\": \"optional\",\n  \"agent_name\": \"optional\",\n  \"client_reference\": \"optional\"\n}\n","json","",[20,85,86,95,112,121,134,147,160,181,192,198,211,224,237,250,262,275,287,298],{"__ignoreMap":83},[87,88,91],"span",{"class":89,"line":90},"line",1,[87,92,94],{"class":93},"sVt8B","{\n",[87,96,98,102,105,109],{"class":89,"line":97},2,[87,99,101],{"class":100},"sj4cs","  \"url\"",[87,103,104],{"class":93},": ",[87,106,108],{"class":107},"sZZnC","\"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=dQw4w9WgXcQ\"",[87,110,111],{"class":93},",\n",[87,113,115,118],{"class":89,"line":114},3,[87,116,117],{"class":100},"  \"options\"",[87,119,120],{"class":93},": {\n",[87,122,124,127,129,132],{"class":89,"line":123},4,[87,125,126],{"class":100},"    \"max_transcript_length\"",[87,128,104],{"class":93},[87,130,131],{"class":100},"10000000",[87,133,111],{"class":93},[87,135,137,140,142,145],{"class":89,"line":136},5,[87,138,139],{"class":100},"    \"include_comments\"",[87,141,104],{"class":93},[87,143,144],{"class":100},"false",[87,146,111],{"class":93},[87,148,150,153,155,158],{"class":89,"line":149},6,[87,151,152],{"class":100},"    \"language\"",[87,154,104],{"class":93},[87,156,157],{"class":107},"\"en\"",[87,159,111],{"class":93},[87,161,163,166,169,172,175,178],{"class":89,"line":162},7,[87,164,165],{"class":100},"    \"summary_modes\"",[87,167,168],{"class":93},": [",[87,170,171],{"class":107},"\"tldr\"",[87,173,174],{"class":93},", ",[87,176,177],{"class":107},"\"detailed\"",[87,179,180],{"class":93},"],\n",[87,182,184,187,189],{"class":89,"line":183},8,[87,185,186],{"class":100},"    \"generate_infographic\"",[87,188,104],{"class":93},[87,190,191],{"class":100},"false\n",[87,193,195],{"class":89,"line":194},9,[87,196,197],{"class":93},"  },\n",[87,199,201,204,206,209],{"class":89,"line":200},10,[87,202,203],{"class":100},"  \"webhook_url\"",[87,205,104],{"class":93},[87,207,208],{"class":107},"\"https:\u002F\u002Fexample.com\u002Fwebhook\"",[87,210,111],{"class":93},[87,212,214,217,219,222],{"class":89,"line":213},11,[87,215,216],{"class":100},"  \"priority\"",[87,218,104],{"class":93},[87,220,221],{"class":107},"\"normal\"",[87,223,111],{"class":93},[87,225,227,230,232,235],{"class":89,"line":226},12,[87,228,229],{"class":100},"  \"custom_instructions\"",[87,231,104],{"class":93},[87,233,234],{"class":107},"\"Pro only\"",[87,236,111],{"class":93},[87,238,240,243,245,248],{"class":89,"line":239},13,[87,241,242],{"class":100},"  \"use_proxy\"",[87,244,104],{"class":93},[87,246,247],{"class":100},"null",[87,249,111],{"class":93},[87,251,253,256,258,260],{"class":89,"line":252},14,[87,254,255],{"class":100},"  \"force_refresh\"",[87,257,104],{"class":93},[87,259,144],{"class":100},[87,261,111],{"class":93},[87,263,265,268,270,273],{"class":89,"line":264},15,[87,266,267],{"class":100},"  \"service_name\"",[87,269,104],{"class":93},[87,271,272],{"class":107},"\"optional\"",[87,274,111],{"class":93},[87,276,278,281,283,285],{"class":89,"line":277},16,[87,279,280],{"class":100},"  \"agent_name\"",[87,282,104],{"class":93},[87,284,272],{"class":107},[87,286,111],{"class":93},[87,288,290,293,295],{"class":89,"line":289},17,[87,291,292],{"class":100},"  \"client_reference\"",[87,294,104],{"class":93},[87,296,297],{"class":107},"\"optional\"\n",[87,299,301],{"class":89,"line":300},18,[87,302,303],{"class":93},"}\n",[16,305,306],{},"Rules:",[30,308,309,316,322,327,332],{},[33,310,311,312,315],{},"free plan supports ",[20,313,314],{},"tldr"," only",[33,317,318,321],{},[20,319,320],{},"priority=high"," requires Pro\u002FAdmin",[33,323,324,321],{},[20,325,326],{},"webhook_url",[33,328,329,321],{},[20,330,331],{},"custom_instructions",[33,333,334,337],{},[20,335,336],{},"options.generate_infographic=true"," requires Pro\u002FAdmin and may still be runtime-disabled",[25,339,341],{"id":340},"summary-modes","Summary Modes",[30,343,344,348,353,358,363],{},[33,345,346],{},[20,347,314],{},[33,349,350],{},[20,351,352],{},"detailed",[33,354,355],{},[20,356,357],{},"study_notes",[33,359,360],{},[20,361,362],{},"timestamped",[33,364,365],{},[20,366,367],{},"key_insights",[25,369,371],{"id":370},"post-apiv1videosprocess-sync",[20,372,42],{},[16,374,375,376,379],{},"This endpoint exists, but it is admin-only and requires an API key with the ",[20,377,378],{},"admin"," permission.",[25,381,383],{"id":382},"get-apiv1videosstatusjob_id",[20,384,48],{},[16,386,387],{},"Returns:",[30,389,390,395,400,405,410,415,420,425,428],{},[33,391,392],{},[20,393,394],{},"job_id",[33,396,397],{},[20,398,399],{},"status",[33,401,402],{},[20,403,404],{},"progress_percentage",[33,406,407],{},[20,408,409],{},"current_step",[33,411,412],{},[20,413,414],{},"estimated_time_remaining",[33,416,417],{},[20,418,419],{},"video_id",[33,421,422],{},[20,423,424],{},"video_url",[33,426,427],{},"timestamps",[33,429,430,431,174,434,174,437],{},"optional attribution fields like ",[20,432,433],{},"service_name",[20,435,436],{},"agent_name",[20,438,439],{},"client_reference",[25,441,443],{"id":442},"get-apiv1videosresultjob_id",[20,444,53],{},[16,446,387],{},[30,448,449,454,459,465,470,475,480],{},[33,450,451],{},[20,452,453],{},"video_info",[33,455,456],{},[20,457,458],{},"transcript",[33,460,461,464],{},[20,462,463],{},"summaries"," keyed by mode",[33,466,467],{},[20,468,469],{},"infographic_url",[33,471,472],{},[20,473,474],{},"processing_time",[33,476,477],{},[20,478,479],{},"completed_at",[33,481,482],{},"optional attribution fields",[16,484,485,486,489,490,23],{},"If the job is not finished yet, the API returns ",[20,487,488],{},"success: false"," with ",[20,491,492],{},"JOB_NOT_COMPLETED",[25,494,496],{"id":495},"get-apiv1videosexportjob_idpdf",[20,497,58],{},[16,499,500],{},"Downloads a PDF export for a completed job.",[30,502,503,506],{},[33,504,505],{},"requires ownership of the job",[33,507,508],{},"requires Pro\u002FAdmin plan",[25,510,512],{"id":511},"get-apiv1videos",[20,513,63],{},[16,515,516],{},"Lists the authenticated user's jobs.",[16,518,519],{},"Query parameters:",[30,521,522,527,532],{},[33,523,524],{},[20,525,526],{},"limit",[33,528,529],{},[20,530,531],{},"offset",[33,533,534],{},[20,535,399],{},[25,537,539],{"id":538},"get-apiv1videosthumbnails",[20,540,68],{},[16,542,543],{},"Query string:",[78,545,550],{"className":546,"code":548,"language":549,"meta":83},[547],"language-text","\u002Fapi\u002Fv1\u002Fvideos\u002Fthumbnails?url=https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=dQw4w9WgXcQ\n","text",[20,551,548],{"__ignoreMap":83},[16,553,554,555,558],{},"This endpoint uses the same auth dependency as the rest of the public video router. In local development with ",[20,556,557],{},"REQUIRE_API_AUTH=false"," it can be called anonymously, but in production it should be treated as authenticated.",[560,561,562],"style",{},"html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":83,"searchDepth":97,"depth":97,"links":564},[565,566,567,568,569,570,571,572,573],{"id":27,"depth":97,"text":28},{"id":71,"depth":97,"text":37},{"id":340,"depth":97,"text":341},{"id":370,"depth":97,"text":42},{"id":382,"depth":97,"text":48},{"id":442,"depth":97,"text":53},{"id":495,"depth":97,"text":58},{"id":511,"depth":97,"text":63},{"id":538,"depth":97,"text":68},"2025-01-20","Current public video-processing endpoints",false,"md",null,{},true,"\u002Fapi\u002Fvideos","TechArticle",{"title":5,"description":575},"api\u002Fvideos",[586,587,588],"api","integration","workflows","2026-03-22","XifZ7z895oWo-WM25daCQA7zzWPa9nq1TOKjT_ok9y8",1792448456891]