[{"data":1,"prerenderedAt":488},["ShallowReactive",2],{"doc-guide\u002Fgetting-started":3},{"id":4,"title":5,"author":6,"body":7,"date":471,"description":472,"draft":473,"extension":474,"faq":475,"meta":476,"navigation":477,"path":478,"schemaType":479,"seo":480,"stem":481,"tags":482,"updatedAt":486,"__hash__":487},"content\u002Fguide\u002Fgetting-started.md","Getting Started","YT2Text Team",{"type":8,"value":9,"toc":459},"minimark",[10,14,23,28,41,47,51,61,65,68,82,85,94,98,185,188,279,283,304,308,328,332,335,362,365,379,383,397,401,404,410,422,426,455],[11,12,5],"h1",{"id":13},"getting-started",[15,16,17,18,22],"p",{},"This guide covers the current public API surface at ",[19,20,21],"code",{},"https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1",".",[24,25,27],"h2",{"id":26},"before-you-start","Before You Start",[29,30,31,35,38],"ul",{},[32,33,34],"li",{},"Create a YT2Text account",[32,36,37],{},"Generate an API key from the dashboard",[32,39,40],{},"Use the public API only for developer integrations",[15,42,43,44,22],{},"The public developer API and the web app's internal API are different surfaces. External integrations should stay on ",[19,45,46],{},"\u002Fapi\u002Fv1\u002F*",[24,48,50],{"id":49},"base-url","Base URL",[52,53,59],"pre",{"className":54,"code":56,"language":57,"meta":58},[55],"language-text","https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1\n","text","",[19,60,56],{"__ignoreMap":58},[24,62,64],{"id":63},"authentication","Authentication",[15,66,67],{},"Pass your API key on every request:",[52,69,73],{"className":70,"code":71,"language":72,"meta":58,"style":58},"language-http shiki shiki-themes github-light github-dark","Authorization: Bearer sk_your_api_key\n","http",[19,74,75],{"__ignoreMap":58},[76,77,80],"span",{"class":78,"line":79},"line",1,[76,81,71],{},[15,83,84],{},"or",[52,86,88],{"className":70,"code":87,"language":72,"meta":58,"style":58},"X-API-Key: sk_your_api_key\n",[19,89,90],{"__ignoreMap":58},[76,91,92],{"class":78,"line":79},[76,93,87],{},[24,95,97],{"id":96},"process-your-first-video","Process Your First Video",[52,99,103],{"className":100,"code":101,"language":102,"meta":58,"style":58},"language-bash shiki shiki-themes github-light github-dark","curl -X POST https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1\u002Fvideos\u002Fprocess \\\n  -H \"Authorization: Bearer sk_your_api_key\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"url\": \"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=dQw4w9WgXcQ\",\n    \"options\": {\n      \"summary_modes\": [\"tldr\"]\n    }\n  }'\n","bash",[19,104,105,125,136,146,155,161,167,173,179],{"__ignoreMap":58},[76,106,107,111,115,119,122],{"class":78,"line":79},[76,108,110],{"class":109},"sScJk","curl",[76,112,114],{"class":113},"sj4cs"," -X",[76,116,118],{"class":117},"sZZnC"," POST",[76,120,121],{"class":117}," https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1\u002Fvideos\u002Fprocess",[76,123,124],{"class":113}," \\\n",[76,126,128,131,134],{"class":78,"line":127},2,[76,129,130],{"class":113},"  -H",[76,132,133],{"class":117}," \"Authorization: Bearer sk_your_api_key\"",[76,135,124],{"class":113},[76,137,139,141,144],{"class":78,"line":138},3,[76,140,130],{"class":113},[76,142,143],{"class":117}," \"Content-Type: application\u002Fjson\"",[76,145,124],{"class":113},[76,147,149,152],{"class":78,"line":148},4,[76,150,151],{"class":113},"  -d",[76,153,154],{"class":117}," '{\n",[76,156,158],{"class":78,"line":157},5,[76,159,160],{"class":117},"    \"url\": \"https:\u002F\u002Fwww.youtube.com\u002Fwatch?v=dQw4w9WgXcQ\",\n",[76,162,164],{"class":78,"line":163},6,[76,165,166],{"class":117},"    \"options\": {\n",[76,168,170],{"class":78,"line":169},7,[76,171,172],{"class":117},"      \"summary_modes\": [\"tldr\"]\n",[76,174,176],{"class":78,"line":175},8,[76,177,178],{"class":117},"    }\n",[76,180,182],{"class":78,"line":181},9,[76,183,184],{"class":117},"  }'\n",[15,186,187],{},"Example response:",[52,189,193],{"className":190,"code":191,"language":192,"meta":58,"style":58},"language-json shiki shiki-themes github-light github-dark","{\n  \"success\": true,\n  \"data\": {\n    \"job_id\": \"uuid\",\n    \"video_id\": \"dQw4w9WgXcQ\",\n    \"status\": \"queued\",\n    \"estimated_completion\": \"2026-03-22T12:00:00Z\"\n  }\n}\n","json",[19,194,195,201,215,223,235,247,259,269,274],{"__ignoreMap":58},[76,196,197],{"class":78,"line":79},[76,198,200],{"class":199},"sVt8B","{\n",[76,202,203,206,209,212],{"class":78,"line":127},[76,204,205],{"class":113},"  \"success\"",[76,207,208],{"class":199},": ",[76,210,211],{"class":113},"true",[76,213,214],{"class":199},",\n",[76,216,217,220],{"class":78,"line":138},[76,218,219],{"class":113},"  \"data\"",[76,221,222],{"class":199},": {\n",[76,224,225,228,230,233],{"class":78,"line":148},[76,226,227],{"class":113},"    \"job_id\"",[76,229,208],{"class":199},[76,231,232],{"class":117},"\"uuid\"",[76,234,214],{"class":199},[76,236,237,240,242,245],{"class":78,"line":157},[76,238,239],{"class":113},"    \"video_id\"",[76,241,208],{"class":199},[76,243,244],{"class":117},"\"dQw4w9WgXcQ\"",[76,246,214],{"class":199},[76,248,249,252,254,257],{"class":78,"line":163},[76,250,251],{"class":113},"    \"status\"",[76,253,208],{"class":199},[76,255,256],{"class":117},"\"queued\"",[76,258,214],{"class":199},[76,260,261,264,266],{"class":78,"line":169},[76,262,263],{"class":113},"    \"estimated_completion\"",[76,265,208],{"class":199},[76,267,268],{"class":117},"\"2026-03-22T12:00:00Z\"\n",[76,270,271],{"class":78,"line":175},[76,272,273],{"class":199},"  }\n",[76,275,276],{"class":78,"line":181},[76,277,278],{"class":199},"}\n",[24,280,282],{"id":281},"check-status","Check Status",[52,284,286],{"className":100,"code":285,"language":102,"meta":58,"style":58},"curl https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1\u002Fvideos\u002Fstatus\u002Fuuid \\\n  -H \"Authorization: Bearer sk_your_api_key\"\n",[19,287,288,297],{"__ignoreMap":58},[76,289,290,292,295],{"class":78,"line":79},[76,291,110],{"class":109},[76,293,294],{"class":117}," https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1\u002Fvideos\u002Fstatus\u002Fuuid",[76,296,124],{"class":113},[76,298,299,301],{"class":78,"line":127},[76,300,130],{"class":113},[76,302,303],{"class":117}," \"Authorization: Bearer sk_your_api_key\"\n",[24,305,307],{"id":306},"get-results","Get Results",[52,309,311],{"className":100,"code":310,"language":102,"meta":58,"style":58},"curl https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1\u002Fvideos\u002Fresult\u002Fuuid \\\n  -H \"Authorization: Bearer sk_your_api_key\"\n",[19,312,313,322],{"__ignoreMap":58},[76,314,315,317,320],{"class":78,"line":79},[76,316,110],{"class":109},[76,318,319],{"class":117}," https:\u002F\u002Fapi.yt2text.cc\u002Fapi\u002Fv1\u002Fvideos\u002Fresult\u002Fuuid",[76,321,124],{"class":113},[76,323,324,326],{"class":78,"line":127},[76,325,130],{"class":113},[76,327,303],{"class":117},[24,329,331],{"id":330},"supported-summary-modes","Supported Summary Modes",[15,333,334],{},"Current modes:",[29,336,337,342,347,352,357],{},[32,338,339],{},[19,340,341],{},"tldr",[32,343,344],{},[19,345,346],{},"detailed",[32,348,349],{},[19,350,351],{},"study_notes",[32,353,354],{},[19,355,356],{},"timestamped",[32,358,359],{},[19,360,361],{},"key_insights",[15,363,364],{},"Plan behavior:",[29,366,367,373,376],{},[32,368,369,370,372],{},"Free: ",[19,371,341],{}," only",[32,374,375],{},"Plus: all five modes",[32,377,378],{},"Pro: all five modes plus webhooks, custom prompts, batch, infographics, AI chat, PDF export, and priority queue",[24,380,382],{"id":381},"important-caveats","Important Caveats",[29,384,385,391,394],{},[32,386,387,390],{},[19,388,389],{},"\u002Fapi\u002Fv1\u002Fauth\u002F*"," manages API keys; it is not a public login\u002Fsignup API.",[32,392,393],{},"Usage endpoints expose current quota counters and persisted job analytics where available, but they are not the billing source of truth.",[32,395,396],{},"Webhook URLs are supported for Pro jobs, but the public API does not currently expose webhook secret management.",[24,398,400],{"id":399},"use-from-ai-agents-mcp","Use From AI Agents (MCP)",[15,402,403],{},"YT2Text also exposes a remote MCP server for Claude Desktop, Cursor, Codex, and any other MCP-capable client:",[52,405,408],{"className":406,"code":407,"language":57,"meta":58},[55],"https:\u002F\u002Fmcp.yt2text.cc\u002Fmcp\n",[19,409,407],{"__ignoreMap":58},[15,411,412,413,416,417,22],{},"Same API key, sent as ",[19,414,415],{},"Authorization: Bearer sk_...",". See ",[418,419,421],"a",{"href":420},"\u002Fguide\u002Fagents","Agents",[24,423,425],{"id":424},"next-steps","Next Steps",[29,427,428,433,437,443,449],{},[32,429,430],{},[418,431,64],{"href":432},"\u002Fguide\u002Fauthentication",[32,434,435],{},[418,436,421],{"href":420},[32,438,439],{},[418,440,442],{"href":441},"\u002Fapi\u002Fvideos","Videos API",[32,444,445],{},[418,446,448],{"href":447},"\u002Fapi\u002Fbatch","Batch API",[32,450,451],{},[418,452,454],{"href":453},"\u002Freference\u002Frate-limits","Rate Limits",[456,457,458],"style",{},"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);}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}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 pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}",{"title":58,"searchDepth":127,"depth":127,"links":460},[461,462,463,464,465,466,467,468,469,470],{"id":26,"depth":127,"text":27},{"id":49,"depth":127,"text":50},{"id":63,"depth":127,"text":64},{"id":96,"depth":127,"text":97},{"id":281,"depth":127,"text":282},{"id":306,"depth":127,"text":307},{"id":330,"depth":127,"text":331},{"id":381,"depth":127,"text":382},{"id":399,"depth":127,"text":400},{"id":424,"depth":127,"text":425},"2025-01-15","Get up and running with the current YT2Text public API.",false,"md",null,{},true,"\u002Fguide\u002Fgetting-started","TechArticle",{"title":5,"description":472},"guide\u002Fgetting-started",[483,484,485],"guide","onboarding","api","2026-03-22","DBAdPTUuzqjxeZ_2NzVp57rLbcLZhuCYNl6UsUzvygo",1792448456901]