Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yourhq.ai/llms.txt

Use this file to discover all available pages before exploring further.

HQ hosted gives you the full platform without managing any infrastructure. You sign up, bring your own model API key, and create agents immediately.
This guide is for the hosted version at app.yourhq.ai. If you want to self-host HQ on your own machine, see the self-host quickstart instead.

​
What you need

An email address

Used for sign-in (magic link — no password to remember).

A model API key

Any provider: OpenAI, Anthropic, or Ollama. You’ll connect this during the onboarding wizard.

​
Step 1 — Sign up and complete the wizard

Go to app.yourhq.ai and click Get started. The onboarding wizard walks you through everything in one flow:
1

Welcome

Enter your name (how agents address you) and confirm your workspace name (auto-generated from your first name, editable).
2

Intent

Pick what you’ll use HQ for: outreach, closing deals, hiring, publishing content, running operations, or just exploring. This seeds your workspace with a matching context preset and recommends your first agent template.
3

Model provider

Choose Anthropic, OpenAI, or Ollama and enter your API key. HQ validates it inline before continuing. Your key is stored securely and never leaves your workspace infrastructure.
Not sure which to start with? Anthropic Claude Sonnet or OpenAI GPT-4.1 are the most capable general-purpose choices. You can add more providers in Settings → Connections later. Compare providers →
4

First agent

HQ recommends an agent based on your intent (e.g. “Scout” for outreach, “Ghost” for publishing). Customize the name and emoji, then create it.Optionally connect a messaging channel:
  • Telegram — create a bot at @BotFather and paste the token
  • Discord — create a bot in the Developer Portal and paste the token
  • Slack — paste App-Level Token and Bot Token from your Slack app
  • Skip — interact through tasks, routines, and the remote desktop instead
After agent creation, you land on the Tasks page with a suggested first task pre-filled based on your intent.

​
Step 2 — Pair your channel (Telegram / Discord only)

If you connected Telegram or Discord, send a DM to your bot. It replies with a 6-digit pairing code. Paste that code in the agent’s detail page → Pairing Code → click Approve. Your next message triggers the agent. Slack agents are active immediately — no pairing step needed.

​
You’re set up

Your hosted HQ is running. Here’s what to explore next:

Pick a model per agent

Assign different models and thinking levels to each agent.

Understand agents

Memory, files, skills, org chart, and how agents actually work.

Set usage budgets

Avoid surprise API bills with per-agent monthly limits.

Manage your account

Add workspaces, manage billing, or cancel.

​
BYO model — how it works

HQ is model-agnostic with a bring-your-own-key approach. You connect your own API keys and pay the model provider directly — HQ never touches your keys for billing or proxies through our servers. You can connect multiple providers and assign different models per agent. See Connect a model provider for the full provider list and per-agent override options.