[{"data":1,"prerenderedAt":377},["ShallowReactive",2],{"navigation":3,"\u002Fdocs\u002Fgetting-started\u002Fusage":18,"\u002Fdocs\u002Fgetting-started\u002Fusage-surround":373},[4],{"title":5,"path":6,"stem":7,"children":8,"icon":17},"Getting Started","\u002Fdocs\u002Fgetting-started","1.docs\u002F1.getting-started\u002F1.index",[9,12],{"title":10,"path":6,"stem":7,"icon":11},"Introduction","i-lucide-house",{"title":13,"path":14,"stem":15,"icon":16},"How to use ch8r?","\u002Fdocs\u002Fgetting-started\u002Fusage","1.docs\u002F1.getting-started\u002F3.usage","i-lucide-sliders",false,{"id":19,"title":13,"body":20,"description":367,"extension":368,"meta":369,"navigation":370,"path":14,"seo":371,"stem":15,"__hash__":372},"docs\u002F1.docs\u002F1.getting-started\u002F3.usage.md",{"type":21,"value":22,"toc":352},"minimark",[23,27,32,35,38,51,58,61,69,73,76,79,99,105,108,113,117,120,123,157,162,168,171,177,181,184,189,216,222,226,250,256,259,265,268,279,283,286,289,301,307,314,320,324,333,339,343,346],[24,25,26],"p",{},"Get started with ch8r by following the built-in onboarding guides. Each step builds on the previous,\ntaking you from initial setup to a fully configured AI support agent.",[28,29,31],"h2",{"id":30},"connect-your-ai-provider","Connect Your AI Provider",[24,33,34],{},"The first onboarding guide prompts you to connect an AI provider. This connection enables ch8r to\ngenerate AI responses and process your knowledge base.",[24,36,37],{},"To connect your AI provider from the onboarding guide:",[39,40,41,45,48],"ul",{},[42,43,44],"li",{},"Select your provider from the dropdown.",[42,46,47],{},"Enter your API Key in the API Key field.",[42,49,50],{},"Click Create.",[24,52,53],{},[54,55],"img",{"alt":56,"src":57},"ch8r onboarding - connect AI Provider","\u002Fdocs\u002Fusage\u002Fonboarding-connect-ai-provider.png",[24,59,60],{},"ch8r validates your credentials immediately and retrieves available models from the provider.\nOnce created, your provider appears in the list with a model count badge.",[62,63,66],"tip",{":to":64,"target":65},"null","_blank",[24,67,68],{},"You can also add a new AI provider under Settings > AI Provider.",[28,70,72],{"id":71},"configure-your-text-model","Configure Your Text Model",[24,74,75],{},"The second onboarding guide configures the text model that generates responses to user queries.",[24,77,78],{},"To configure your text model from the onboarding guide:",[39,80,81,84,96],{},[42,82,83],{},"In the onboarding guide, you'll see available text models fetched from your connected provider.",[42,85,86,87,91,92,95],{},"Select a model (e.g., ",[88,89,90],"code",{},"gemini-1.5-pro"," or ",[88,93,94],{},"gemini-1.5-flash",").",[42,97,98],{},"Click Configure.",[24,100,101],{},[54,102],{"alt":103,"src":104},"ch8r onboarding - configure models","\u002Fdocs\u002Fusage\u002Fonboarding-configure-models.png",[24,106,107],{},"At this point, you can start chatting with your AI. Navigate to your application's chat\ninterface and begin testing basic conversations.",[62,109,110],{":to":64,"target":65},[24,111,112],{},"You can also, click the settings icon next to your app name (top-left) and go to AI Models to configure models.",[28,114,116],{"id":115},"build-your-knowledge-base","Build Your Knowledge Base",[24,118,119],{},"While basic chat works, ch8r's full potential comes from grounding responses in your actual content.\nThe knowledge base onboarding guide helps you ingest your documentation.",[24,121,122],{},"To add knowledge base content:",[39,124,125,140],{},[42,126,127,128,131,132,135,136,139],{},"From the onboarding guide or ",[88,129,130],{},"Application"," > ",[88,133,134],{},"Knowledge Base",", click ",[88,137,138],{},"Add Knowledge Base",".",[42,141,142,143],{},"Choose your source type:\n",[39,144,145,148,151,154],{},[42,146,147],{},"File: Upload PDFs, text files, or Markdown documents",[42,149,150],{},"URL: Enter a web address; enable crawling to recursively fetch linked pages",[42,152,153],{},"GitHub: Select a repository and branch (requires a connected integration)",[42,155,156],{},"Text: Paste content directly for quick testing",[62,158,159],{":to":64,"target":65},[24,160,161],{},"Knowledge base processing requires an embedding model. On the Knowledge Base page, the onboarding guide will prompt you to configure one.",[24,163,164],{},[54,165],{"alt":166,"src":167},"ch8r onboarding - configure embedding model","\u002Fdocs\u002Fusage\u002Fonboarding-configure-embedding-model.png",[24,169,170],{},"When you select Version Control as a knowledge base source, you’ll need to connect a version control integration.",[24,172,173],{},[54,174],{"alt":175,"src":176},"ch8r onboarding - version control as kb","\u002Fdocs\u002Fusage\u002Fonboarding-version-control-as-kb.png",[28,178,180],{"id":179},"configure-integrations","Configure Integrations",[24,182,183],{},"Integrations enable your AI to interact with external tools - creating tickets, listing commits, or checking issue status directly from chat conversations.",[185,186,188],"h3",{"id":187},"to-add-an-integration","To add an integration:",[39,190,191,202,205,213],{},[42,192,127,193,131,196,135,199],{},[88,194,195],{},"Settings",[88,197,198],{},"Integrations",[88,200,201],{},"Connect Integration",[42,203,204],{},"Select your service (currently GitHub)",[42,206,207,208],{},"Enter your credentials:\n",[39,209,210],{},[42,211,212],{},"GitHub: Create a Personal Access Token.",[42,214,215],{},"Name your integration and click Connect",[24,217,218],{},[54,219],{"alt":220,"src":221},"ch8r onboarding - connect integrations","\u002Fdocs\u002Fusage\u002Fonboarding-connect-integrations.png",[185,223,225],{"id":224},"to-link-the-integration-to-your-application","To link the integration to your application:",[39,227,228,244,247],{},[42,229,230,231,131,233,236,237,239,240,243],{},"Navigate to ",[88,232,130],{},[88,234,235],{},"Settings icon"," next to application name > ",[88,238,198],{}," or click on ",[88,241,242],{},"Configure App Integration"," card from onboarding UI.",[42,245,246],{},"Select your connected integration",[42,248,249],{},"Select repository and branch (for version control and project management using GitHub)",[24,251,252],{},[54,253],{"alt":254,"src":255},"ch8r onboarding - app integration configuration","\u002Fdocs\u002Fusage\u002Fonboarding-app-integration-configuration.png",[24,257,258],{},"From this page, you can enable actions for each integration. If a user reports an issue, the AI can create a ticket. If they ask about releases, it can list commits to generate a response.",[24,260,261],{},[54,262],{"alt":263,"src":264},"ch8r onboarding - tools","\u002Fdocs\u002Fusage\u002Fonboarding-tools.png",[24,266,267],{},"Toggle actions on\u002Foff based on your needs:",[39,269,270,273,276],{},[42,271,272],{},"list_commits — Let users ask \"What changed recently?\"",[42,274,275],{},"create_ticket — Let users say \"File a bug for this\"",[42,277,278],{},"list_tickets — Let users ask \"Show open issues\"",[28,280,282],{"id":281},"embed-the-widget","Embed the Widget",[24,284,285],{},"The final step makes your AI available to customers via an embeddable chat widget.",[24,287,288],{},"To enable the widget:",[39,290,291,298],{},[42,292,230,293,131,295],{},[88,294,130],{},[88,296,297],{},"Widget",[42,299,300],{},"Enable Widget.",[24,302,303],{},[54,304],{"alt":305,"src":306},"ch8r onboarding - enable widget","\u002Fdocs\u002Fusage\u002Fch8r-onboarding-enable-widget.png",[24,308,309,310,313],{},"After enabling the widget, you can configure its theme, position, description, brand name, and\ngreeting, and preview it live. Once you're satisfied, copy the embed code and add the provided\nscript tag before the closing ",[88,311,312],{},"\u003C\u002Fbody>"," tag.",[24,315,316],{},[54,317],{"alt":318,"src":319},"ch8r onboarding - embed script","\u002Fdocs\u002Fusage\u002Fonboarding-embed-script.png",[28,321,323],{"id":322},"agent-configuration","Agent Configuration",[24,325,326,327,330,331,139],{},"You can define your agent’s persona, tone, and response style by clicking the ",[88,328,329],{},"settings icon","\nnext to the application name, then navigating to ",[88,332,323],{},[24,334,335],{},[54,336],{"alt":337,"src":338},"onboarding - agent configuration","\u002Fdocs\u002Fusage\u002Fonboarding-agent-configuration.png",[28,340,342],{"id":341},"rate-limiting","Rate Limiting",[24,344,345],{},"ch8r includes configurable rate limiting to protect your AI endpoints from abuse\nand manage costs. Rate limits apply to widget-based chat requests on a per-user\nbasis.",[24,347,348],{},[54,349],{"alt":350,"src":351},"onboarding - rate limiting","\u002Fdocs\u002Fusage\u002Fonboarding-rate-limiting.png",{"title":353,"searchDepth":354,"depth":354,"links":355},"",2,[356,357,358,359,364,365,366],{"id":30,"depth":354,"text":31},{"id":71,"depth":354,"text":72},{"id":115,"depth":354,"text":116},{"id":179,"depth":354,"text":180,"children":360},[361,363],{"id":187,"depth":362,"text":188},3,{"id":224,"depth":362,"text":225},{"id":281,"depth":354,"text":282},{"id":322,"depth":354,"text":323},{"id":341,"depth":354,"text":342},"How to use ch8r in practice, from basic setup to workflows.","md",{},{"icon":16},{"title":13,"description":367},"wzvwEYtur0f6saAsoGp0gr0A3IaresuTeToLNNPTdjE",[374,376],{"title":10,"path":6,"stem":7,"description":375,"icon":11,"children":-1},"Welcome to ch8r - AI customer support that takes actions, not just replies.",null,1776185200487]