Quickstart

This walks through your first few calls with a personal access token. Export it first:

export HQ_TOKEN="hq_pat_..."

Verify your token

curl https://api.hq.zone/v1/api/me -H "Authorization: Bearer $HQ_TOKEN"

Returns your identity, workspace, and onboarding state.

List your agents

curl https://api.hq.zone/v1/agents -H "Authorization: Bearer $HQ_TOKEN"

Each agent has an id, slug, name, model, and status. Copy an id for the next step.

Start a conversation

curl -X POST https://api.hq.zone/v1/api/conversations \
  -H "Authorization: Bearer $HQ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"<AGENT_ID>"}'

Returns the new conversation’s id.

Send a message

curl -X POST https://api.hq.zone/v1/api/conversations/<CONVERSATION_ID>/messages \
  -H "Authorization: Bearer $HQ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"Summarize our latest board deck."}'

This returns 202 Accepted with a stream_url — the turn runs server-side on the agent’s machine.

The reply doesn’t come back in that response — you read it live over the event stream.

Stream the reply

Open the conversation’s event stream and render the agent’s response as it happens.

Get started

Concepts

Guides

API essentials

Quickstart

Stream the reply