Developers
Use HQ from your terminal with the hq CLI, from your editor with the VS Code extension, and from your own code with the HQ API.
Everything you do in HQ, you can also do from your own tools.
Get an API key in 2 minutes
- Create a key
In HQ, open Profile, then API keys, and select Create key. Name it, tick the scopes it needs and create it. The key is shown once: copy it into your secret manager or an environment variable.
- Call the API
curl https://api-hq.aiworkforceone.com/v1/me \ -H "Authorization: Bearer $HQ_API_KEY"
Next, follow the API quickstart to start a session and send it a prompt, or read about authentication and service keys.
Machine-readable docs
Every page has a Markdown copy: use Copy page, or Open in to ask Claude or ChatGPT about it. llms.txt lists every page, and llms-full.txt has all of them in one file.
Was this page helpful?