Developers
Everything Halo does in its window, your own code can do too. This section covers calling Halo from scripts and services, running it as a server, building Digital Humans and skills, and sharing what you build.
Where to start
| You want to | Start here |
|---|---|
| Send Halo work from a script and read the result | Quickstart: call the Halo API |
| Put a Digital Human behind your own product or chat | Halo Server integration guide |
| Run Halo on a server, without a desktop | Halo Server quickstart |
| Build a Digital Human that works on its own | Building Digital Humans |
| Teach the AI a task, or give it new tools | Writing skills, MCP configuration reference |
| Share what you built | DHP protocol, Publish to the Store |
Call Halo
Halo answers HTTP requests and streams its progress over a WebSocket, on the desktop while Settings › Remote Access is on, and always on Halo Server. Every API call except sign-in and the status check carries the access password, which grants full control of that Halo.
- HTTP API overview: base URL, authentication, errors, and the operations by group
- WebSocket events: follow replies and status as they happen
- API recipes: chat with a Digital Human, one thread per user, answer its questions, webhooks
Run Halo as a service
Halo Server is the same app without a window, in a Linux container, for back ends that call it all day.
- Halo Server quickstart, configuration and Docker deployment
- Integration guide and examples: Digital Humans as the AI back end of your systems
Build Digital Humans
- Building Digital Humans: what one is made of and how it runs
- Tutorial: build a browser-automation Digital Human
- Digital Human spec reference, generated from Halo's schema
- Production-grade Digital Humans: prompts, memory, browser scripts and safe limits
Extend Halo
- Writing skills: instructions and scripts the AI follows for one kind of task
- MCP configuration reference: connect tools from local programs or remote servers
- Operate Halo: let Halo's own assistant change workspaces, Digital Humans and settings for the user
Share what you build
- DHP protocol: the
.dhpkgpackage and the Store format - Publish to the Store: publish Digital Humans and skills from Halo
- Private Store sources: serve your company's own catalog
Docs for AI tools
These pages are also available as plain Markdown for coding assistants and other AI tools. See Docs for AI tools.