[{"data":1,"prerenderedAt":515},["ShallowReactive",2],{"doc-guide/agents":3},{"id":4,"title":5,"author":6,"body":7,"date":495,"description":496,"draft":497,"extension":498,"faq":499,"meta":500,"navigation":501,"path":502,"schemaType":503,"seo":504,"stem":505,"tags":506,"updatedAt":495,"__hash__":514},"content/guide/agents.md","Agents","YT2Text Team",{"type":8,"value":9,"toc":485},"minimark",[10,14,23,26,50,55,58,72,75,98,102,105,129,132,156,162,166,169,200,204,207,223,226,235,238,242,360,364,404,408,458,462,465,476,481],[11,12,5],"h1",{"id":13},"agents",[15,16,17,18,22],"p",{},"YT2Text is usable from AI agents today through the public REST API at ",[19,20,21],"code",{},"https://api.yt2text.cc/api/v1",".",[15,24,25],{},"The public onboarding files are:",[27,28,29,35,40,45],"ul",{},[30,31,32],"li",{},[19,33,34],{},"https://yt2text.cc/skill.md",[30,36,37],{},[19,38,39],{},"https://yt2text.cc/skill.json",[30,41,42],{},[19,43,44],{},"https://yt2text.cc/skill.jsonl",[30,46,47],{},[19,48,49],{},"https://yt2text.cc/agents",[51,52,54],"h2",{"id":53},"who-this-is-for","Who this is for",[15,56,57],{},"This guide is for agent systems that can:",[27,59,60,63,66,69],{},[30,61,62],{},"read Markdown instructions",[30,64,65],{},"store API keys securely",[30,67,68],{},"make authenticated HTTPS requests",[30,70,71],{},"poll asynchronous jobs and fetch results later",[15,73,74],{},"That includes common agent/operator environments such as:",[27,76,77,80,83,86,89,92,95],{},[30,78,79],{},"Codex",[30,81,82],{},"GPT-based agents",[30,84,85],{},"Claude",[30,87,88],{},"Claude Code",[30,90,91],{},"OpenClaw",[30,93,94],{},"Hermes agents",[30,96,97],{},"internal orchestration agents",[51,99,101],{"id":100},"human-setup","Human setup",[15,103,104],{},"Before an agent can call the API, a human must:",[106,107,108,114,120,126],"ol",{},[30,109,110,111],{},"Create an account at ",[19,112,113],{},"https://yt2text.cc/auth/signup",[30,115,116,117],{},"Choose a plan at ",[19,118,119],{},"https://yt2text.cc/pricing",[30,121,122,123],{},"Open ",[19,124,125],{},"https://yt2text.cc/dashboard/api-keys",[30,127,128],{},"Create an API key and copy it immediately",[15,130,131],{},"Plan gates:",[27,133,134,144,150],{},[30,135,136,139,140,143],{},[19,137,138],{},"free",": no API keys, ",[19,141,142],{},"tldr"," only",[30,145,146,149],{},[19,147,148],{},"plus",": API keys enabled, all summary modes",[30,151,152,155],{},[19,153,154],{},"pro",": batch processing, webhooks, custom prompts, PDF export, infographics, AI chat, priority queue",[15,157,158,159,161],{},"If the goal is external agent usage, ",[19,160,148],{}," is the minimum plan.",[51,163,165],{"id":164},"api-first-workflow","API-first workflow",[15,167,168],{},"Recommended flow:",[106,170,171,176,182,188,194],{},[30,172,173,174],{},"Read ",[19,175,34],{},[30,177,178,179],{},"Store the key in an environment variable such as ",[19,180,181],{},"YT2TEXT_API_KEY",[30,183,184,185],{},"Submit a video with ",[19,186,187],{},"POST /api/v1/videos/process",[30,189,190,191],{},"Poll ",[19,192,193],{},"GET /api/v1/videos/status/{job_id}",[30,195,196,197],{},"Fetch ",[19,198,199],{},"GET /api/v1/videos/result/{job_id}",[51,201,203],{"id":202},"authentication","Authentication",[15,205,206],{},"Preferred header:",[208,209,214],"pre",{"className":210,"code":211,"language":212,"meta":213,"style":213},"language-http shiki shiki-themes github-light github-dark","Authorization: Bearer \u003Capi_key>\n","http","",[19,215,216],{"__ignoreMap":213},[217,218,221],"span",{"class":219,"line":220},"line",1,[217,222,211],{},[15,224,225],{},"Also supported:",[208,227,229],{"className":210,"code":228,"language":212,"meta":213,"style":213},"X-API-Key: \u003Capi_key>\n",[19,230,231],{"__ignoreMap":213},[217,232,233],{"class":219,"line":220},[217,234,228],{},[15,236,237],{},"Query parameter authentication is not supported.",[51,239,241],{"id":240},"example-request","Example request",[208,243,247],{"className":244,"code":245,"language":246,"meta":213,"style":213},"language-bash shiki shiki-themes github-light github-dark","curl -X POST https://api.yt2text.cc/api/v1/videos/process \\\n  -H \"Authorization: Bearer $YT2TEXT_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\",\n    \"options\": {\n      \"summary_modes\": [\"tldr\", \"detailed\"],\n      \"language\": \"en\"\n    },\n    \"service_name\": \"agent-platform\",\n    \"agent_name\": \"research-agent\",\n    \"client_reference\": \"job-123\"\n  }'\n","bash",[19,248,249,269,287,297,306,312,318,324,330,336,342,348,354],{"__ignoreMap":213},[217,250,251,255,259,263,266],{"class":219,"line":220},[217,252,254],{"class":253},"sScJk","curl",[217,256,258],{"class":257},"sj4cs"," -X",[217,260,262],{"class":261},"sZZnC"," POST",[217,264,265],{"class":261}," https://api.yt2text.cc/api/v1/videos/process",[217,267,268],{"class":257}," \\\n",[217,270,272,275,278,282,285],{"class":219,"line":271},2,[217,273,274],{"class":257},"  -H",[217,276,277],{"class":261}," \"Authorization: Bearer ",[217,279,281],{"class":280},"sVt8B","$YT2TEXT_API_KEY",[217,283,284],{"class":261},"\"",[217,286,268],{"class":257},[217,288,290,292,295],{"class":219,"line":289},3,[217,291,274],{"class":257},[217,293,294],{"class":261}," \"Content-Type: application/json\"",[217,296,268],{"class":257},[217,298,300,303],{"class":219,"line":299},4,[217,301,302],{"class":257},"  -d",[217,304,305],{"class":261}," '{\n",[217,307,309],{"class":219,"line":308},5,[217,310,311],{"class":261},"    \"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\",\n",[217,313,315],{"class":219,"line":314},6,[217,316,317],{"class":261},"    \"options\": {\n",[217,319,321],{"class":219,"line":320},7,[217,322,323],{"class":261},"      \"summary_modes\": [\"tldr\", \"detailed\"],\n",[217,325,327],{"class":219,"line":326},8,[217,328,329],{"class":261},"      \"language\": \"en\"\n",[217,331,333],{"class":219,"line":332},9,[217,334,335],{"class":261},"    },\n",[217,337,339],{"class":219,"line":338},10,[217,340,341],{"class":261},"    \"service_name\": \"agent-platform\",\n",[217,343,345],{"class":219,"line":344},11,[217,346,347],{"class":261},"    \"agent_name\": \"research-agent\",\n",[217,349,351],{"class":219,"line":350},12,[217,352,353],{"class":261},"    \"client_reference\": \"job-123\"\n",[217,355,357],{"class":219,"line":356},13,[217,358,359],{"class":261},"  }'\n",[51,361,363],{"id":362},"agent-specific-guidance","Agent-specific guidance",[27,365,366,369,372,387,394],{},[30,367,368],{},"Prefer async processing, not synchronous assumptions",[30,370,371],{},"Keep keys server-side only",[30,373,374,375,378,379,382,383,386],{},"Use ",[19,376,377],{},"service_name",", ",[19,380,381],{},"agent_name",", and ",[19,384,385],{},"client_reference"," for correlation",[30,388,389,390,393],{},"Treat ",[19,391,392],{},"/api/v1/usage/*"," as diagnostic today, not billing truth",[30,395,396,397,400,401],{},"Back off on ",[19,398,399],{},"429"," responses using ",[19,402,403],{},"Retry-After",[51,405,407],{"id":406},"public-documentation","Public documentation",[27,409,410,417,422,428,434,440,446,452],{},[30,411,412],{},[413,414,416],"a",{"href":415},"/guide/getting-started","Getting Started",[30,418,419],{},[413,420,203],{"href":421},"/guide/authentication",[30,423,424],{},[413,425,427],{"href":426},"/api/videos","Videos API",[30,429,430],{},[413,431,433],{"href":432},"/api/batch","Batch API",[30,435,436],{},[413,437,439],{"href":438},"/api/webhooks","Webhooks",[30,441,442],{},[413,443,445],{"href":444},"/reference/rate-limits","Rate Limits",[30,447,448],{},[413,449,451],{"href":450},"/reference/sdk-roadmap","SDK roadmap",[30,453,454],{},[413,455,457],{"href":456},"/reference/agents-roadmap","Agents roadmap",[51,459,461],{"id":460},"what-comes-next","What comes next",[15,463,464],{},"The sequence for YT2Text agent support is:",[106,466,467,470,473],{},[30,468,469],{},"REST API and public skill files",[30,471,472],{},"first-party SDKs",[30,474,475],{},"MCP after the API and SDK contract is hardened",[15,477,478,479,22],{},"See ",[413,480,457],{"href":456},[482,483,484],"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":213,"searchDepth":271,"depth":271,"links":486},[487,488,489,490,491,492,493,494],{"id":53,"depth":271,"text":54},{"id":100,"depth":271,"text":101},{"id":164,"depth":271,"text":165},{"id":202,"depth":271,"text":203},{"id":240,"depth":271,"text":241},{"id":362,"depth":271,"text":363},{"id":406,"depth":271,"text":407},{"id":460,"depth":271,"text":461},"2026-03-30","Use YT2Text from Codex, GPT agents, Claude, Claude Code, OpenClaw, Hermes agents, and other agent runtimes through the public REST API and skill files.",false,"md",null,{},true,"/guide/agents","TechArticle",{"title":5,"description":496},"guide/agents",[507,13,508,509,510,511,512,513],"guide","api","skill","codex","claude","gpt","mcp","asYxYVPj0Sg4GrCYr1NMVVIMouDn0abrDA6nzbwTH-4",1776525479692]