Hawi documentation
How the product works, in the order you meet it. 75 pages, and an ask box on every one of them that searches all of it.
Popular
- QuickstartWorkspace, one connection, one agent, one ceiling. About twenty minutes, most of it waiting for a provider to authorise.
- Core conceptsThe eight nouns the rest of the documentation assumes you know.
- Limits and ceilingsThe per-agent spending ceiling that starts at nothing, the approval queue you configure, and what each one is and is not.
- The connector catalogueCustomer-connectable providers from the connector registry.
- The developer APIThree read-only endpoints, two scopes, bearer authentication, and keys you issue and rotate yourself.
- GlossaryEvery term the product and this documentation use, in one list.
Everything
Start here
What this is, and the shortest path to an agent doing one real job.
- What Hawi isNamed agents that work orders, stock and customer messages across the systems a shop already runs, on a board a person can read.
- QuickstartWorkspace, one connection, one agent, one ceiling. About twenty minutes, most of it waiting for a provider to authorise.
- Core conceptsThe eight nouns the rest of the documentation assumes you know.
- The first weekWhat actually happens between opening a workspace and trusting it, day by day.
- Who it fits, and who it does notThe shape of operation this suits, and four where something else is the better tool.
- How this differs from the things it resemblesAgainst a chatbot, an automation builder, a helpdesk macro, and a virtual assistant.
- Before you startThe eight things worth having ready, and the two decisions worth making first.
Workspaces
The boundary everything sits inside, and the people in it.
- WorkspacesThe boundary everything sits inside, when to open a second one, and what does not cross between them.
- People and rolesWho can see a board, who can brief an agent, and where a role actually comes from.
- Workspace settingsWhat is configured at the workspace level rather than per agent or per account.
- Inviting peopleWhat a new member sees, what they can do before a role is set, and when to add the second person.
- Running several workspacesWhat is shared, what is not, and how cross-workspace delegation differs from both.
Agents
Briefs, models, handoffs, and the limits you set.
- AgentsA named worker with a brief, a model, a tool list, a ceiling and a run history.
- ModelsThe six models an agent can run, what they cost relative to each other, and why there is no place to paste your own API key.
- HandoffsHow work moves between agents, and from an agent to a person, carrying its evidence.
- Limits and ceilingsThe per-agent spending ceiling that starts at nothing, the approval queue you configure, and what each one is and is not.
- Writing briefsHow briefs shape agent behaviour, with four worked examples and their failure modes.
- When an agent misbehavesA diagnostic order for the six things that actually go wrong, starting with the trace.
- Control modesThe three governance settings, what each one changes, and what none of them is.
- Tool listsHow an agent reaches a system, why two gates apply, and what the narrower one is.
- When agents workWhat starts a run, active hours, and why continuous is rarely the right answer.
- Creating, pausing and retiringWhat happens to work in flight when an agent changes, and the one change that needs care.
Work
The five stages, boards, and voice.
- BoardsWhere work is visible: items with a source, a status and an owner who may be a person or an agent.
- IntakeTurning mail, marketplace messages and stock alerts into board items with a source, status and owner.
- WatchRecalculating stock cover from sales, comparing listings against the stock sheet, scheduling supplier follow-ups.
- ApprovalsThe queue where the actions you routed to a person wait, showing the current record beside the proposed change.
- MonitorThe daily brief, and tracing a result back through its inputs, tool calls, handoffs and decisions.
- VoiceSpeech generation, call preview, and an exact account of which parts of voice are wired up today and which are not.
- Worked examplesFour operational exceptions end to end: a lost parcel, an oversell, a late supplier, a damaged item.
- The daily briefWhat is in it, what is deliberately not, and the one number worth reading first.
- Items in depthEvery field on a board item, where each one comes from, and what happens when two arrivals are the same thing.
- Reading a traceWhat a trace contains, in what order, and the three things to look at first.
- Team conversationThe room for the people, why agents are not in it, and how a message becomes work.
- What creates workEvery route by which an item can appear, and the threshold each one applies.
Connections
Available connectors, how one is authorised, and where secrets live.
- ConnectionsHow an external system is authorised once against your account and then selected by a workspace, and the four states a provider can be in.
- The connector catalogueCustomer-connectable providers from the connector registry.
- Custom connectorsPointing Hawi at a system that is not in the catalogue, and how each operation is risk-classified.
- Connection securityWhere credentials live, what is never shown again, and what Hawi will not do with a secret.
- When a connection will not connectThe five things that break an authorisation, in the order they break.
- WebhooksHow inbound provider events are verified, and why an unverifiable one is dropped.
- Scopes, read and writeHow access is decided, why a declared read can be classified as a write, and what to grant first.
- Setting up, by connection typeThe four routes a provider reaches Hawi by, and what each asks of you.
- Commerce connectionsWhat is specific about shops and marketplaces, and the two questions to settle before connecting one.
- External MCP serversPointing an agent at tools you host, and where the trust boundary sits.
Billing
Credits, plans and seats.
- CreditsThe unit of metered work, what consumes it, and why no number on this page is a charge.
- Plans and seatsWhat a plan row carries, why no figure is written down here, and how trials and annual pricing behave.
- Voice billingWhy voice is an add-on rather than a tier feature, and how minutes are counted.
- Reading your usageWhere the authoritative figure lives, what the run lifecycle meters, and how to forecast.
- Running out, and auto-rechargeWhat stops, what finishes, and the three outcomes an automatic top-up can have.
- Seats, teams and shared creditWhat a seat buys, why balances are account-scoped, and how larger arrangements differ.
Developer API
Three read-only endpoints and the keys that reach them.
- The developer APIThree read-only endpoints, two scopes, bearer authentication, and keys you issue and rotate yourself.
- AuthenticationKey format, the one moment a secret is visible, expiry options, and rotation.
- Read a workspaceGET /api/v1/workspaces/{workspaceId} — the fields it returns and the two ways it 404s.
- List workspace filesGET /api/v1/workspaces/{workspaceId}/files — metadata only, paginated, never file content.
- PaginationCursors, the default and maximum page size, and what an invalid cursor does.
- Rate limitsTwo stages — one by network origin, one by key — the headers they set, and how to back off.
- ErrorsThe error shape, every status the API returns, and the header that tells you which of two 401s you hit.
- Your first API requestFrom nothing to a verified key and a real response, in about five minutes.
- Writing a clientRetries, backoff, pagination and the four failures worth handling separately.
- Handling keys safelyWhat a leaked key can and cannot do, and what to do in the first ten minutes.
Interface
Settings, accessibility and the keyboard.
- Interface settingsTheme, density, text size, motion, and how much of the machinery you want to see.
- AccessibilityThe four controls that are first class, the contrast floor, and what is not claimed.
- KeyboardThe command menu, and how it is opened from anywhere.
- NotificationsThe three styles, when agents work, and the custom cadence range.
- How much you want to seeNo-code, low-code and dev, and which one to pick in the first week.
- FilesWhat a workspace accepts, how a file is checked, and why the filename is rewritten.
Reference
Vocabulary, glossary, and getting help.
- Status vocabularyEvery status and outcome word the product uses, and exactly what each one commits to.
- GlossaryEvery term the product and this documentation use, in one list.
- Getting helpWhat to gather before asking, and what these documentation pages will never contain.
- Every limit in one placeThe numbers scattered through these pages, collected, with what happens when you reach each one.
- Questions people actually askThe dozen questions that arrive most often, answered in one line each where possible.
- How your data is handledWhere things are stored, what is never returned, and what this page does not claim.
- The security modelWhere each decision is made, what is server-enforced, and the rule behind all of it.
- What is not built yetEvery preview and gap in one list, so nothing here has to be discovered.
- Where everything is documentedA map from the question you have to the page that answers it.