# Halo Docs (Halo AI Workstation) > Halo is an open-source (MIT) desktop AI workstation: chat, code and make documents on your own computer with agent engines such as Claude Code and Codex, and run Digital Humans that stay on duty and work in teams, reachable from your phone, Feishu, WeChat or WeCom. Free and open source; model usage is billed by your account or API provider; macOS 12+ (Apple silicon/Intel), Windows 10+ x64, Linux glibc 2.34+, Android remote client; current version 3.0.4. ## How AI assistants should use these docs - These docs describe the current Halo release (3.0.4). Features marked `since: "3.0"` do not exist in 2.x. - UI labels are quoted exactly as the app shows them: English labels on English pages, Simplified Chinese labels on Chinese pages. - Sign-in options, message channels and store sources can differ between builds and enterprise editions: do not assert that a specific computer has an option; the user's screen is the authority. - Every page has a `.md` version at the same path; the full text is in llms-full.txt. - Inside Halo, users can simply ask Halo, which reads these docs itself. The HTTP API reference is under Developers › HTTP API. ## Docs home - [Halo AI Workstation Docs: Guides, Digital Humans and API](https://hello-halo.cc/docs/en/index.md): Official docs for Halo, the open-source desktop AI workstation: install, connect a model, hand off work, run Digital Humans and teams, and use the HTTP API. ## Get started ### About Halo - [What is Halo: open-source Claude Code desktop app](https://hello-halo.cc/docs/en/guide/what-is-halo.md): Halo is a free, open-source AI desktop app that puts Claude Code's agent power in an interface anyone can use: documents, websites and Digital Humans. - [Glossary: Halo terms and UI names](https://hello-halo.cc/docs/en/guide/glossary.md): Halo glossary: short definitions of workspace, Digital Human, team, capabilities, knowledge base, memory and other terms, with the exact UI labels. - [Philosophy - Kill Ugly Raw Source](https://hello-halo.cc/docs/en/guide/philosophy.md): The design philosophy behind Halo: bringing frontier AI capabilities to everyone through a beautiful desktop experience. ### Quick start - [Get started with Halo: install and first task](https://hello-halo.cc/docs/en/getting-started/index.md): Start using Halo in four steps: install the app, connect an AI model, finish a first real task, and learn the layout. Each step says what you should see. - [Install Halo on macOS, Windows and Linux](https://hello-halo.cc/docs/en/getting-started/install.md): Download and install Halo, handle the first-launch prompts, and set up the command environment on Windows. “Let's set things up” means Halo is installed. - [Connect an AI model: sign in or use an API key](https://hello-halo.cc/docs/en/getting-started/setup-ai.md): Halo needs an AI model to work. Pick a free sign-in, an account you already pay for, an API key, or skip for now, then follow the steps for it. - [Get an API key: OpenAI, DeepSeek and more](https://hello-halo.cc/docs/en/getting-started/api-keys.md): Create an API key with a model provider such as OpenAI, Anthropic or DeepSeek, then paste it into Halo with the matching provider selected. - [Quick start: your first task in Halo](https://hello-halo.cc/docs/en/getting-started/first-chat.md): Give Halo a task in one sentence and watch it make a real file. Along the way, learn to add instructions, stop a reply and answer Halo's questions. - [A tour of Halo: rail, conversations and tasks](https://hello-halo.cc/docs/en/getting-started/app-tour.md): Learn the Halo 3.0 window: the six entries on the left rail, the conversation view, composer buttons, the More menu, the task panel, search and Settings. ### Coming from another tool - [Coming from Claude Code: concepts and config](https://hello-halo.cc/docs/en/guide/from-claude-code.md): Using Claude Code or Codex? How the concepts map, signing in with your subscription, opening a repo as a workspace, keeping CLAUDE.md, skills and MCP. ## Guides ### Everyday use - [Halo guides: how to use every feature](https://hello-halo.cc/docs/en/features/index.md): Halo guides by topic: everyday use, what the AI can do, developer tools, working from anywhere, settings and admin pages, from workspaces to Remote Access. - [Workspaces (Spaces): keep each project separate](https://hello-halo.cc/docs/en/features/spaces.md): A Halo workspace (formerly a Space) keeps one project's folder, conversations, Digital Humans, skills and memory together and apart from other projects. - [Conversations: manage, steer and reference replies](https://hello-halo.cc/docs/en/features/conversations.md): Create, pin, rename and delete conversations in Halo, choose the send key, add to or stop a running reply, read a reply, quote passages and set a goal. - [Image input and file attachments in Halo](https://hello-halo.cc/docs/en/features/image-input.md): Give Halo images, files and folders. The desktop app reads files in place, web and Android upload them, and models without image input get on-device OCR. - [Models and accounts: switch models, Deep Thinking](https://hello-halo.cc/docs/en/features/models.md): Manage models and accounts in Halo: several sign-ins side by side, API keys and custom endpoints, and a model and Deep Thinking level per conversation. - [Memory: how Halo remembers your preferences](https://hello-halo.cc/docs/en/features/memory.md): Halo's memory is the notes the AI keeps for itself. A workspace's conversations share one memory, and each Digital Human has its own. Set, tidy or clear it. - [Task panel: running work and what needs you](https://hello-halo.cc/docs/en/features/tasks.md): Halo's task panel lists running work, questions waiting for your answer and fresh results from every workspace in one place, so one click takes you back. - [Parallel work: run several conversations at once](https://hello-halo.cc/docs/en/features/parallel-work.md): Run several Halo conversations side by side, add instructions while the AI works, follow progress in the task panel, and hand bigger jobs to a team. ### What the AI can do - [Capabilities: per-conversation AI tool switches](https://hello-halo.cc/docs/en/features/capabilities.md): The Capabilities switches under the composer's + decide which tools Halo's AI can use in a conversation, such as Web Control, AI Terminal and Operate Halo. - [AI Browser Automation: browse, fill forms, scrape](https://hello-halo.cc/docs/en/features/ai-browser.md): Turn on Web Control and Halo's AI Browser opens pages, clicks, fills forms, downloads files and collects page data, reusing sites you've signed in to. - [AI Terminal: a real terminal you share with the AI](https://hello-halo.cc/docs/en/features/ai-terminal.md): Halo's AI Terminal is a real terminal you and the AI share. Log in over SSH and hand over, run long jobs or drive REPLs. On macOS and Windows. - [Knowledge Base: AI answers from your documents](https://hello-halo.cc/docs/en/features/knowledge-base.md): Put PDFs, Office files, images and text into a Halo knowledge base, and the AI reads them before answering and cites sources. Learning is local and token-free. - [Office documents: Word, Excel and PPT with AI](https://hello-halo.cc/docs/en/features/office-documents.md): Have Halo create and edit Word, Excel, PowerPoint and PDF files with its built-in document skills. Nothing to install; files land in your workspace folder. - [Files and the canvas: preview and edit your files](https://hello-halo.cc/docs/en/features/files-and-canvas.md): Manage workspace files in Halo's resources rail, preview and edit code, Markdown, tables, images and PDFs in the canvas, and read the NEW/MOD badges. - [Email and calendar for Halo Digital Humans](https://hello-halo.cc/docs/en/features/email.md): Set up one mailbox in Halo and your Digital Humans can check, search, send and sort your mail. Add a CalDAV URL and they can manage your calendar too. - [Conversations that work together: read and ask](https://hello-halo.cc/docs/en/features/cross-conversation.md): In Halo, the AI in one conversation can read other conversations in its workspace, hand a decision over, or ask and wait for a reply. Digital Humans can join. - [Operate Halo: let the AI manage your workspaces](https://hello-halo.cc/docs/en/features/operate-halo.md): Turn on Operate Halo and the AI can rename conversations, create workspaces, pause Digital Humans, bind knowledge bases and switch models in Halo for you. ### For developers - [Changes view: diffs, AI code review and Git](https://hello-halo.cc/docs/en/features/code-review.md): Use Halo's Changes view to read the Git diffs in your workspace, run a quick or team AI code review, then stage, commit and push. - [Agent engines: Claude Code, Codex and more](https://hello-halo.cc/docs/en/features/agent-engines.md): Halo's agent engine drives the AI's work: Claude Code SDK by default, or the experimental Halo SDK, Codex SDK or DeepSeek dsh. How to switch and what differs. - [Skills: install and use reusable AI skills in Halo](https://hello-halo.cc/docs/en/features/skills.md): Halo skills are reusable instructions the AI follows. Install them from the Store or add your own, then let the AI pick them or call one with /name. - [MCP servers: connect external tools to Halo](https://hello-halo.cc/docs/en/features/mcp.md): Connect MCP servers in Halo's Capability library. Add one by hand or paste JSON for several, test the connection, switch tools, and choose who gets them. - [Commands and shortcuts: slash, IM and keyboard](https://hello-halo.cc/docs/en/features/commands.md): Commands and shortcuts in Halo — the / menu in chat, IM commands that stop or clear a Digital Human's bot chat, and every keyboard shortcut and send key. ### Anywhere - [Remote Access: use Halo from a phone or another PC](https://hello-halo.cc/docs/en/features/remote-access.md): Turn on Remote Access in the Halo desktop app to use this computer's Halo from a phone or another computer, on the same network or over the internet. - [Halo on your phone: Android app and phone browser](https://hello-halo.cc/docs/en/features/mobile.md): Connect the Halo Android app or your phone's browser to Halo on your computer: check progress, send messages and answer Digital Humans on the go. ### Settings and tips - [Settings reference: every option and its default](https://hello-halo.cc/docs/en/features/settings.md): Every Halo Settings section, field by field, from AI Model to About. What each option does, its default and range, and which ones are desktop-only. - [Best practices: workspaces, context and models](https://hello-halo.cc/docs/en/advanced/best-practices.md): Best practices for Halo: one workspace per project, one topic per conversation, tidy memory, the right model and Deep Thinking level, and a few safety habits. ### Use cases & comparisons - [Use cases: Halo examples by job](https://hello-halo.cc/docs/en/use-cases/index.md): Ways to use Halo for office admin, marketing, sales, finance, students and developers: each is a sentence you can copy to Halo, with a link to the full guide. - [AI desktop agent that works on your own computer](https://hello-halo.cc/docs/en/seo/ai-desktop-agent.md): Halo is an open-source AI desktop agent: it works with your files, drives a browser and a terminal, and makes Office documents to finish tasks end to end. - [AI digital workers that run on your computer](https://hello-halo.cc/docs/en/seo/ai-digital-worker.md): Create AI digital workers with Halo: describe the job and how often, and it works on schedule, reports to WeCom, Feishu or email, and asks before decisions. - [Claude Code GUI and Codex GUI in one app](https://hello-halo.cc/docs/en/seo/claude-code-desktop.md): Halo is an open-source GUI for Claude Code and Codex: no terminal, sign in with your account or any compatible API, and follow up from your phone. ### Admins and IT - [IT and admins: Halo security review and rollout](https://hello-halo.cc/docs/en/advanced/index.md): Halo for IT and admins — facts for a security review, then deployment, model gateway and proxy, updates, private store, Halo Server and logs. - [Security and permissions: data and AI access](https://hello-halo.cc/docs/en/advanced/security.md): Security and permissions in Halo — what leaves your computer, how keys are stored, what the AI, IM guests and colleagues may do, and Remote Access risks. - [Deploy Halo to many computers and set defaults](https://hello-halo.cc/docs/en/advanced/deployment.md): Roll Halo out to a team's computers: requirements and installers, Git Bash on Windows, what users see on first launch, and what you can set in advance. - [Model gateway and proxy: company API gateway setup](https://hello-halo.cc/docs/en/advanced/gateway-and-proxy.md): Add your company's OpenAI- or Anthropic-compatible model gateway to Halo as an AI source, set a proxy and bypass list, and see what works offline. - [Deploy the Federation Gateway for remote teams](https://hello-halo.cc/docs/en/advanced/federation-gateway.md): Self-host the Halo Federation Gateway so computers on different networks can share a Digital Human team: deploy it, add HTTPS, then set it in Remote Access. - [Decentralized AI agent teams: Raft-style consensus](https://hello-halo.cc/docs/en/advanced/team-consensus.md): Halo's AI agent teams (Digital Humans) run on members' own computers. No central server holds team state; a Raft-style host rotates, so the board never forks. - [Update Halo: automatic updates and manual checks](https://hello-halo.cc/docs/en/advanced/updates.md): Halo downloads new versions in the background and shows one prompt to finish. Check manually, and learn about Windows fast updates and mandatory updates. - [Private store: add your own Store sources to Halo](https://hello-halo.cc/docs/en/advanced/private-store.md): Manage Halo's Store sources in Settings › App Store. Learn the 5 built-in sources, add a private source, turn sources on or off, and see what it must serve. - [Config paths: Halo data, settings and log folders](https://hello-halo.cc/docs/en/advanced/config-paths.md): Config paths for Halo on macOS, Windows and Linux. Where your data, settings and credentials, logs, skills and Claude config live, and how to open each folder. - [Move Halo to a new computer with your data](https://hello-halo.cc/docs/en/advanced/migrate.md): Move Halo to a new computer: the two folders to copy, why paths must match, what to sign in to again, and how to move one Digital Human as a package. ## Digital Humans ### Digital Humans - [Digital Humans: AI members that work on a schedule](https://hello-halo.cc/docs/en/digital-humans/overview.md): Halo Digital Humans are AI members on duty: they work on a schedule, take requests in WeCom, Feishu or WeChat, and report back. How they differ from chats. - [Create a Digital Human: three ways](https://hello-halo.cc/docs/en/digital-humans/create.md): Create a Digital Human in Halo: tell Halo what it should do, install a ready-made one from the Store, or build one with a form or an imported file. - [Digital Human schedules and triggers](https://hello-halo.cc/docs/en/digital-humans/triggers.md): Decide when a Halo Digital Human works: on an interval or at set times, only on China working days, on bot messages, by hand, or from an HTTP request. - [Capabilities and settings: each group explained](https://hello-halo.cc/docs/en/digital-humans/capabilities.md): Each group of a Halo Digital Human's Capabilities and settings tab: identity, trigger, parameters, model and capabilities, tools, messages, advanced, YAML. - [Manage Digital Humans: runs, questions, export](https://hello-halo.cc/docs/en/digital-humans/manage.md): See what each run of a Halo Digital Human did, answer its questions, run or pause it by hand, export it for a colleague, or uninstall it. - [Keep Digital Humans running on your computer](https://hello-halo.cc/docs/en/digital-humans/keep-running.md): Halo Digital Humans run on your own computer. Set it up so they work on time: closing vs quitting, launch at startup, sleep, notifications and phone access. - [Digital Human reminders: one-off or repeating](https://hello-halo.cc/docs/en/digital-humans/reminders.md): Ask a Halo Digital Human in its chat to remind you, and it reminds you in that chat on time. Reminders set in WeCom, Feishu or WeChat come back there. - [Digital Human Store: install and update](https://hello-halo.cc/docs/en/digital-humans/store.md): Find Digital Humans and skills others built in the Halo Store, fill in a few settings and put them to work; plus updates, MCP servers and sharing your own. - [Digital Human avatar: get the same one as in Halo](https://hello-halo.cc/docs/en/digital-humans/avatar.md): Every Halo Digital Human's avatar comes from its name. Enter the name to get the same avatar and download a PNG or SVG for a chat bot or anywhere you need one. ### Teams - [Digital Human Collaboration: teams that split work](https://hello-halo.cc/docs/en/digital-humans/collaboration.md): Let several Halo Digital Humans team up on a bigger job: start a temporary collaboration in one sentence, keep it, and bring in colleagues' Digital Humans. - [The team workbench: tasks, members and outputs](https://hello-halo.cc/docs/en/digital-humans/team-workbench.md): Open a saved Halo team to hand it tasks, follow members' progress and outputs, answer the decisions waiting for you, and run, pause, leave or dissolve the team. - [Saved teams and schedules: members and runs](https://hello-halo.cc/docs/en/digital-humans/saved-teams.md): Keep a temporary collaboration or build a Halo team by hand: pick members, write a goal, then add a schedule, an HTTP trigger and periodic checks. - [Teams across computers: invite colleagues](https://hello-halo.cc/docs/en/digital-humans/cross-computer-teams.md): Invite colleagues to bring their own Halo Digital Humans into your team, on one network or via a Federation Gateway, and decide what they may ask of yours. ### Message channels - [Message channels: WeCom, Feishu and WeChat bots](https://hello-halo.cc/docs/en/digital-humans/channels.md): Let colleagues reach Halo Digital Humans from WeCom, Feishu or WeChat, or have results sent out: two-way bots versus one-way notifications, and which to use. - [WeCom Intelligent Bot: connect a Digital Human](https://hello-halo.cc/docs/en/digital-humans/wecom-bot.md): Scan once with WeCom on your phone to bring a Halo Digital Human into WeCom, where colleagues can message it or @mention it in groups. Manual setup works too. - [WeCom bot advanced: groups, commands, files](https://hello-halo.cc/docs/en/digital-humans/wecom-bot-features.md): After connecting a WeCom bot: @mention it in groups, control it with /stop and /clear, exchange files, handle long replies, and have it post to groups. - [WeCom: show real names instead of anonymized IDs](https://hello-halo.cc/docs/en/digital-humans/wecom-name-resolution.md): WeCom hides who messages a bot, so Halo contacts show only IDs. Authorize the Message capability in WeCom and paste the link into Halo to show real names. - [Feishu Bot: scan to create the app and connect](https://hello-halo.cc/docs/en/digital-humans/feishu-bot.md): Scan once with Feishu on your phone and Halo creates the Feishu app and connects a Digital Human for you. Lark and manual setup with an App ID work too. - [WeChat Bot: chat with a Digital Human in WeChat](https://hello-halo.cc/docs/en/digital-humans/personal-wechat.md): Scan once with WeChat to chat with a Halo Digital Human in your personal WeChat, no WeCom account needed. Direct chats only, and no owner or guest roles. - [Notifications and proactive push: send results out](https://hello-halo.cc/docs/en/digital-humans/notifications.md): Let Halo Digital Humans send results out on their own: to people and groups who messaged their bot, or via email, WeCom, DingTalk, Feishu and webhooks. - [Owner and guest permissions for Halo bots](https://hello-halo.cc/docs/en/digital-humans/permissions.md): Use Permission Control to split WeCom and Feishu bot users into owners and guests: owners can have the Digital Human do anything, guests only what you allow. ## Developers ### Start - [Halo for developers: API, Server, Digital Humans](https://hello-halo.cc/docs/en/developers/index.md): Halo for developers: call the HTTP API and WebSocket, run Halo Server, build Digital Humans, write skills and MCP configurations, and publish packages. - [Call the Halo API: quickstart](https://hello-halo.cc/docs/en/developers/quickstart.md): Quickstart for the Halo API: turn on Remote Access, get the address and access password, make your first curl request, and stream the reply over WebSocket. - [Docs for AI tools: llms.txt and Markdown pages](https://hello-halo.cc/docs/en/developers/docs-for-ai.md): Docs for AI tools: where Halo publishes llms.txt, full-text bundles and a Markdown copy of every page, and how Halo's own assistant reads its guides. ### HTTP API - [Halo HTTP API reference: base URL, auth and errors](https://hello-halo.cc/docs/en/developers/api/index.md): Halo HTTP API overview: base URL, authentication, request and response conventions, errors, real-time events, and the documented endpoint groups. - [Conversations API: start and manage conversations](https://hello-halo.cc/docs/en/developers/api/conversation.md): Halo HTTP API for conversations: start a turn of work, stop it, see what is running, and list, read, rename, star and delete conversations. - [Workspaces API: workspaces, files and memory](https://hello-halo.cc/docs/en/developers/api/workspace.md): Halo HTTP API for workspaces and files: create, reorder and delete workspaces, change their settings and memory, and browse and read their files. - [Digital Humans API: install, configure and chat](https://hello-halo.cc/docs/en/developers/api/digital-human.md): Halo HTTP API for Digital Humans: install and uninstall, pause and resume, configure, read run history and activity, and chat with them. - [Teams API: members, runs and triggers](https://hello-halo.cc/docs/en/developers/api/team.md): Halo HTTP API for teams of Digital Humans: create and dissolve teams, manage members, start and stop runs, set triggers, and read boards and outputs. - [Knowledge base API: import and index documents](https://hello-halo.cc/docs/en/developers/api/knowledge-base.md): Halo HTTP API for knowledge bases: create and delete collections, bind them to workspaces and Digital Humans, import documents and follow indexing. - [Message channels API: IM chats and notifications](https://hello-halo.cc/docs/en/developers/api/channels.md): Halo HTTP API for message channels and notifications: connect IM channels, bind chats to Digital Humans, read chat transcripts, test notifications. - [Settings API: models, version and diagnostics](https://hello-halo.cc/docs/en/developers/api/settings.md): Halo HTTP API for settings and models: version, model sources and switching models, security policy, agent engines and MCP server diagnostics. - [Store API: browse, install and update](https://hello-halo.cc/docs/en/developers/api/store.md): Halo HTTP API for the Store: browse and search listings, install and uninstall Digital Humans and skills, and manage Store sources and updates. - [Terminal API: create, type into and read sessions](https://hello-halo.cc/docs/en/developers/api/terminal.md): Halo HTTP API for terminal sessions: create a session, send input, resize it, read back its output and close it again. - [Halo API recipes: Digital Humans and webhooks](https://hello-halo.cc/docs/en/developers/api/recipes.md): Halo API recipes: chat with a Digital Human, one thread per user, answer its questions, exchange files, chain Digital Humans, start runs by webhook. - [WebSocket event protocol: follow Halo in real time](https://hello-halo.cc/docs/en/developers/api/websocket.md): Halo WebSocket events: connect and authenticate, subscribe to conversations, who receives what, and every event channel, terminal stream included. ### Build Digital Humans - [Building Halo Digital Humans: how they work](https://hello-halo.cc/docs/en/developers/digital-humans/index.md): How a Halo Digital Human is put together and runs: its spec, workspace, memory and triggers, what a run sees, and when to ask Halo instead of writing a spec. - [Tutorial: build a browser-automation Digital Human](https://hello-halo.cc/docs/en/developers/digital-humans/build.md): Tutorial: turn Halo's OA approval sample into a Digital Human that works in a web system you sign in to, with bundled browser scripts, memory and safe defaults. - [Digital Human spec.yaml reference: all fields](https://hello-halo.cc/docs/en/developers/digital-humans/spec.md): Reference for the Digital Human spec.yaml: every field with its type, default and allowed values, the rules Halo checks, and the fields that have no effect. - [Production-grade Digital Humans: prompts & scripts](https://hello-halo.cc/docs/en/developers/digital-humans/production.md): Make a Halo Digital Human reliable enough to run unattended: a step-by-step prompt, memory that prevents repeats, browser scripts, logins and safe limits. - [DHP protocol: Digital Human packages and stores](https://hello-halo.cc/docs/en/developers/dhp.md): DHP, the Digital Human Protocol: the .dhpkg package format and its limits, the static store layout with its index files, and what a DHP v2 store server adds. - [Publish to the Store: Digital Humans and skills](https://hello-halo.cc/docs/en/developers/store-publishing.md): Publish a Digital Human or skill to the Halo Store: fill in the release info, pass the pre-flight checks, manage versions, and export packages to share by hand. ### Extensions - [Writing skills for Halo: SKILL.md reference](https://hello-halo.cc/docs/en/developers/skills.md): Write skills for Halo: the SKILL.md format and its fields, companion files and scripts, where Halo finds skills and how it names them, testing, and packaging. - [MCP configuration reference: fields and JSON](https://hello-halo.cc/docs/en/developers/mcp.md): Reference for MCP servers in Halo: configuration fields and transports, the JSON formats Halo accepts, packaging a server, and how Digital Humans get them. ### Halo Server - [Halo Server quickstart: run Halo as a service](https://hello-halo.cc/docs/en/server/index.md): Halo Server quickstart: run Halo as a service on Linux, open the desktop interface in a browser, and call its API from your systems. - [Halo Server configuration: environment variables](https://hello-halo.cc/docs/en/server/configuration.md): Halo Server configuration reference: environment variables for server mode, port, data directory, access password and your own LLM gateway. - [Docker deployment: run Halo Server in a container](https://hello-halo.cc/docs/en/server/deployment-docker.md): Deploy Halo Server with Docker: build the image from the Halo repository, mount a persistent volume, and set the access password and LLM gateway. - [Serverless deployment (Knative) of Halo Server](https://hello-halo.cc/docs/en/server/deployment-faas.md): Deploy Halo Server on a Knative function platform: prepare the image, set variables, mount NFS, size resources and avoid scaling pitfalls. - [Halo Server integration guide: AI agent back end](https://hello-halo.cc/docs/en/server/integration.md): Halo Server integration guide: use Digital Humans as your AI back end, give each user a chat thread, and get replies by WebSocket or polling. - [Halo Server integration examples: curl and Java](https://hello-halo.cc/docs/en/server/examples.md): Halo Server integration examples: a curl walkthrough for a support Digital Human, a WebSocket event stream and a Java ask() wrapper. - [Build your own image & how it works](https://hello-halo.cc/docs/en/server/build.md): Build your own Halo Server image from source to rebrand, change the built-in provider or follow the latest code, and see how the headless server works. ## Help ### Help - [Help center: start here when Halo has a problem](https://hello-halo.cc/docs/en/troubleshooting/index.md): Start here when something goes wrong in Halo: ask Halo first, look up the exact error text, or find the page for your problem; then what to send us. - [Halo FAQ: cost, data, models and Digital Humans](https://hello-halo.cc/docs/en/troubleshooting/faq.md): Short answers to common Halo questions: what it costs, where your data goes, whether the AI asks before changing files, which models work, offline use, phones. - [Common errors: what Halo error messages mean](https://hello-halo.cc/docs/en/troubleshooting/common-errors.md): Look up the exact message you see in Halo: interrupted replies, model errors and rate limits, context limits, images, Windows, Digital Humans, bots and teams. - [Model API error codes: 401, 429, 5xx and fixes](https://hello-halo.cc/docs/en/troubleshooting/api-errors.md): What Halo shows when a model service returns 401, 402, 403, 404, 429 or 5xx, which errors retry on their own, and whether to check key, quota or network. - [Install and launch problems: fixes for Halo](https://hello-halo.cc/docs/en/troubleshooting/install.md): When Halo won't install, open or get past first launch: system requirements, Mac and Windows security prompts, Windows first-time setup, Linux AppImage, logs. - [Bot not replying: WeCom, Feishu and WeChat bots](https://hello-halo.cc/docs/en/troubleshooting/channels.md): When a Halo bot in WeCom, Feishu or WeChat doesn't reply, check in order: Halo running, connection, the bound Digital Human, Reply Scope, @mentions, owner. - [A Digital Human did not run: missed runs](https://hello-halo.cc/docs/en/troubleshooting/digital-humans.md): When a Halo Digital Human misses its schedule, shows Not started, stops after repeated failures or stays queued, find the cause and get it working again. - [Logs and diagnostics: report, logs, bug reports](https://hello-halo.cc/docs/en/troubleshooting/diagnostics.md): How to check Halo and collect information when something breaks. Run System Diagnostics, export a report, find logs and crash reports, and record full requests. ### Reference and news - [Changelog: what's new in each Halo release](https://hello-halo.cc/docs/en/guide/changelog.md): Halo changelog: new features, improvements and fixes in each release, newest first, taken from Halo's release notes. - [Contact & Community: reach the Halo team](https://hello-halo.cc/docs/en/contact.md): Join the Halo WeChat user group, report problems and ideas on GitHub, or reach the Halo team by email, X and Bilibili; plus where to ask what. ## Halo assistant guides (raw text read by Halo's built-in AI) - [Halo Official Guides — Index](https://hello-halo.cc/docs/ai-guides/index.md) - [AI Browser — Controlling Halo's Embedded Browser](https://hello-halo.cc/docs/ai-guides/ai-browser/index.md) - [browser_run — Writing Production Browser Automation Scripts](https://hello-halo.cc/docs/ai-guides/ai-browser/scripting.md) - [Configuring AI Models — What Actually Happens in Settings → AI Model](https://hello-halo.cc/docs/ai-guides/ai-model-setup/index.md) - [AI Model Setup — Troubleshooting](https://hello-halo.cc/docs/ai-guides/ai-model-setup/troubleshooting.md) - [AI Terminal — A Persistent Terminal Shared with the User](https://hello-halo.cc/docs/ai-guides/ai-terminal/index.md) - [Worked Examples](https://hello-halo.cc/docs/ai-guides/create-digital-human/examples.md) - [IM / WeCom Triggering — How It Actually Works](https://hello-halo.cc/docs/ai-guides/create-digital-human/im-triggers.md) - [Interview Checklist — What to Ask, and What Not To](https://hello-halo.cc/docs/ai-guides/create-digital-human/interview-checklist.md) - [Creating a Halo Digital Human — What the Tools Don't Tell You](https://hello-halo.cc/docs/ai-guides/create-digital-human/SKILL.md) - [App Spec Field Reference (condensed, automation-focused)](https://hello-halo.cc/docs/ai-guides/create-digital-human/spec-reference.md) - [Email Setup — Mailbox Tools vs. Notification Alerts](https://hello-halo.cc/docs/ai-guides/email-setup/index.md) - [Getting Started — Install, First Run, Updates, and Where Files Live](https://hello-halo.cc/docs/ai-guides/getting-started/index.md) - [Knowledge Base — Documents the AI Answers From](https://hello-halo.cc/docs/ai-guides/knowledge-base/index.md) - [Message Channels — WeCom Bot, WeChat iLink Bot, Feishu Bot, and IM Wiring](https://hello-halo.cc/docs/ai-guides/message-channels/index.md) - [WeCom Intelligent Bot (企业微信智能机器人) — Setup, Permissions, Diagnosis](https://hello-halo.cc/docs/ai-guides/message-channels/wecom-bot.md) - [WeChat Bot / iLink (微信机器人) — Setup, Limits, Diagnosis](https://hello-halo.cc/docs/ai-guides/message-channels/weixin-ilink.md) - [Remote Access — HTTP API, Auth, and the Internet Tunnel](https://hello-halo.cc/docs/ai-guides/remote-access/index.md) - [Skills & MCP — Installing, Scoping, and Authoring](https://hello-halo.cc/docs/ai-guides/skills-and-mcp/index.md) - [Spaces, Space Conversations, and Digital Humans](https://hello-halo.cc/docs/ai-guides/spaces-and-agents/index.md)