[{"data":1,"prerenderedAt":382},["ShallowReactive",2],{"page:\u002Fguides\u002Fgetting-started":3},{"id":4,"title":5,"apiPage":6,"body":7,"description":373,"extension":374,"layout":375,"meta":376,"navigation":377,"path":378,"playground":375,"seo":379,"stem":380,"__hash__":381},"docs\u002Fguides\u002Fgetting-started.md","Getting Started",false,{"type":8,"value":9,"toc":363},"minimark",[10,14,21,24,29,32,35,38,47,51,54,65,69,72,77,90,96,100,112,145,148,152,155,203,319,323,359],[11,12,5],"h1",{"id":13},"getting-started",[15,16,17],"caution",{},[18,19,20],"p",{},"This API is in beta and may change without notice.",[18,22,23],{},"Work with your YouViCo projects from an AI app through MCP, or from your own tools through the API.",[25,26,28],"h2",{"id":27},"connect-with-mcp","Connect with MCP",[18,30,31],{},"Connect an AI app that supports MCP, such as Claude or ChatGPT, and ask about your projects in plain language.",[33,34],"mcp-connect",{},[18,36,37],{},"Once connected, ask the app something like \"What comments were left on the Launch Campaign project?\"",[18,39,40,41,46],{},"See ",[42,43,45],"a",{"href":44},"\u002Fguides\u002Fmcp","MCP"," for what the app can do and how to disconnect it.",[25,48,50],{"id":49},"let-ai-set-it-up","Let AI set it up",[18,52,53],{},"Paste this into an AI app or coding assistant, such as Claude, ChatGPT, Claude Code, or Cursor, and it handles the setup for you.",[55,56,62],"pre",{"className":57,"code":59,"language":60,"meta":61},[58],"language-text","Set up YouViCo for me by following https:\u002F\u002Fdevelopers.youvico.com\u002Fguides\u002Fgetting-started.\n- If you can connect MCP servers, add https:\u002F\u002Fapi.youvico.com\u002Fmcp as a remote MCP server and walk me through signing in.\n- If I want code instead, have me create an API key, then build the integration with the guides and API reference at https:\u002F\u002Fdevelopers.youvico.com. Keep the key in the YOUVICO_API_KEY environment variable.\nReply in the language I write in.\n","text","",[63,64,59],"code",{"__ignoreMap":61},[25,66,68],{"id":67},"use-the-api","Use the API",[18,70,71],{},"Call the API directly from your own tools with an API key.",[73,74,76],"h3",{"id":75},"create-an-api-key","1. Create an API key",[18,78,79,80,84,85,89],{},"Sign in to the ",[42,81,83],{"href":82},"\u002Fconsole","Console"," with your YouViCo account and create a key for your workspace.\nChoose the ",[42,86,88],{"href":87},"\u002Fguides\u002Fpermissions#scopes","scopes"," your integration needs.",[91,92,93],"warning",{},[18,94,95],{},"The key is shown only once. Copy it and store it somewhere safe.",[73,97,99],{"id":98},"check-the-key","2. Check the key",[18,101,102,103,106,107,111],{},"Send the key in the ",[63,104,105],{},"Authorization"," header and call ",[42,108,110],{"href":109},"\u002Fapi-references\u002Fauth\u002Fping","Ping",":",[55,113,117],{"className":114,"code":115,"language":116,"meta":61,"style":61},"language-bash shiki shiki-themes ayu-light ayu-light ayu-dark","curl 'https:\u002F\u002Fapi.youvico.com\u002Fapi\u002Fping' \\\n  -H 'Authorization: Bearer YOUR_API_KEY'\n","bash",[63,118,119,136],{"__ignoreMap":61},[120,121,124,128,132],"span",{"class":122,"line":123},"line",1,[120,125,127],{"class":126},"s6MYo","curl",[120,129,131],{"class":130},"sHwJV"," 'https:\u002F\u002Fapi.youvico.com\u002Fapi\u002Fping'",[120,133,135],{"class":134},"sTJUr"," \\\n",[120,137,139,142],{"class":122,"line":138},2,[120,140,141],{"class":134},"  -H",[120,143,144],{"class":130}," 'Authorization: Bearer YOUR_API_KEY'\n",[18,146,147],{},"The response shows the workspace the key belongs to and its scopes.",[73,149,151],{"id":150},"make-your-first-request","3. Make your first request",[18,153,154],{},"Search the projects in that workspace:",[55,156,158],{"className":114,"code":157,"language":116,"meta":61,"style":61},"curl -X QUERY 'https:\u002F\u002Fapi.youvico.com\u002Fapi\u002Fprojects' \\\n  -H 'Authorization: Bearer YOUR_API_KEY' \\\n  -H 'Content-Type: application\u002Fjson' \\\n  -d '{ \"keyword\": \"launch\" }'\n",[63,159,160,175,184,194],{"__ignoreMap":61},[120,161,162,164,167,170,173],{"class":122,"line":123},[120,163,127],{"class":126},[120,165,166],{"class":134}," -X",[120,168,169],{"class":130}," QUERY",[120,171,172],{"class":130}," 'https:\u002F\u002Fapi.youvico.com\u002Fapi\u002Fprojects'",[120,174,135],{"class":134},[120,176,177,179,182],{"class":122,"line":138},[120,178,141],{"class":134},[120,180,181],{"class":130}," 'Authorization: Bearer YOUR_API_KEY'",[120,183,135],{"class":134},[120,185,187,189,192],{"class":122,"line":186},3,[120,188,141],{"class":134},[120,190,191],{"class":130}," 'Content-Type: application\u002Fjson'",[120,193,135],{"class":134},[120,195,197,200],{"class":122,"line":196},4,[120,198,199],{"class":134},"  -d",[120,201,202],{"class":130}," '{ \"keyword\": \"launch\" }'\n",[55,204,208],{"className":205,"code":206,"language":207,"meta":61,"style":61},"language-json shiki shiki-themes ayu-light ayu-light ayu-dark","{\n  \"data\": [\n    {\n      \"id\": \"bdbff5de-96d7-468f-9db0-85fe28bd6b62\",\n      \"name\": \"Launch Campaign\"\n    }\n  ],\n  \"page\": {\n    \"next\": null,\n    \"prev\": null\n  }\n}\n","json",[63,209,210,216,228,233,246,257,263,271,282,296,307,313],{"__ignoreMap":61},[120,211,212],{"class":122,"line":123},[120,213,215],{"class":214},"snvv_","{\n",[120,217,218,222,225],{"class":122,"line":138},[120,219,221],{"class":220},"soLcz","  \"data\"",[120,223,111],{"class":224},"sgRSP",[120,226,227],{"class":214}," [\n",[120,229,230],{"class":122,"line":186},[120,231,232],{"class":214},"    {\n",[120,234,235,238,240,243],{"class":122,"line":196},[120,236,237],{"class":220},"      \"id\"",[120,239,111],{"class":224},[120,241,242],{"class":130}," \"bdbff5de-96d7-468f-9db0-85fe28bd6b62\"",[120,244,245],{"class":224},",\n",[120,247,249,252,254],{"class":122,"line":248},5,[120,250,251],{"class":220},"      \"name\"",[120,253,111],{"class":224},[120,255,256],{"class":130}," \"Launch Campaign\"\n",[120,258,260],{"class":122,"line":259},6,[120,261,262],{"class":214},"    }\n",[120,264,266,269],{"class":122,"line":265},7,[120,267,268],{"class":214},"  ]",[120,270,245],{"class":224},[120,272,274,277,279],{"class":122,"line":273},8,[120,275,276],{"class":220},"  \"page\"",[120,278,111],{"class":224},[120,280,281],{"class":214}," {\n",[120,283,285,288,290,294],{"class":122,"line":284},9,[120,286,287],{"class":220},"    \"next\"",[120,289,111],{"class":224},[120,291,293],{"class":292},"ss_QQ"," null",[120,295,245],{"class":224},[120,297,299,302,304],{"class":122,"line":298},10,[120,300,301],{"class":220},"    \"prev\"",[120,303,111],{"class":224},[120,305,306],{"class":292}," null\n",[120,308,310],{"class":122,"line":309},11,[120,311,312],{"class":214},"  }\n",[120,314,316],{"class":122,"line":315},12,[120,317,318],{"class":214},"}\n",[25,320,322],{"id":321},"next-steps","Next steps",[324,325,326,332,339,346,353],"ul",{},[327,328,329,331],"li",{},[42,330,45],{"href":44},": connect an AI app to YouViCo",[327,333,334,338],{},[42,335,337],{"href":336},"\u002Fguides\u002Frequests","Requests & Responses",": how requests and responses are shaped",[327,340,341,345],{},[42,342,344],{"href":343},"\u002Fguides\u002Fpermissions","Permissions",": what a key can reach and do",[327,347,348,352],{},[42,349,351],{"href":350},"\u002Fguides\u002Ferrors","Errors",": how to handle failed requests",[327,354,355,358],{},[42,356,357],{"href":109},"API Reference",": every endpoint",[360,361,362],"style",{},"html pre.shiki code .s6MYo, html code.shiki .s6MYo{--shiki-light:#22A4E6;--shiki-default:#22A4E6;--shiki-dark:#59C2FF}html pre.shiki code .sHwJV, html code.shiki .sHwJV{--shiki-light:#86B300;--shiki-default:#86B300;--shiki-dark:#AAD94C}html pre.shiki code .sTJUr, html code.shiki .sTJUr{--shiki-light:#4CBF99;--shiki-default:#4CBF99;--shiki-dark:#95E6CB}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}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 .snvv_, html code.shiki .snvv_{--shiki-light:#5C6166;--shiki-default:#5C6166;--shiki-dark:#BFBDB6}html pre.shiki code .soLcz, html code.shiki .soLcz{--shiki-light:#55B4D4;--shiki-default:#55B4D4;--shiki-dark:#39BAE6}html pre.shiki code .sgRSP, html code.shiki .sgRSP{--shiki-light:#5C6166B3;--shiki-default:#5C6166B3;--shiki-dark:#BFBDB6B3}html pre.shiki code .ss_QQ, html code.shiki .ss_QQ{--shiki-light:#A37ACC;--shiki-default:#A37ACC;--shiki-dark:#D2A6FF}",{"title":61,"searchDepth":196,"depth":196,"links":364},[365,366,367,372],{"id":27,"depth":138,"text":28},{"id":49,"depth":138,"text":50},{"id":67,"depth":138,"text":68,"children":368},[369,370,371],{"id":75,"depth":186,"text":76},{"id":98,"depth":186,"text":99},{"id":150,"depth":186,"text":151},{"id":321,"depth":138,"text":322},"Connect an AI app to YouViCo through MCP, or create an API key and make your first request from your own tools.","md",null,{},true,"\u002Fguides\u002Fgetting-started",{"title":5,"description":373},"guides\u002Fgetting-started","hOMt5BqCjutzkezeu5le0TWUpqgGvMivST7YSHoGoWE",1792305905257]