Raíz is Arbol’s product for contact with each patient. Its AI agents talk with a clinic’s or a hospital’s patients on the phone, on WhatsApp and in a chat on its website: they answer when patients get in touch, and they can call them. They follow the instructions you give them, consult your documents, use your integrations’ tools, and hand a conversation to your team when a person is needed. Everything Raíz keeps belongs to one organization, and you reach it through the Raíz API.
The model
Raíz is built from these parts:
- The organization is your clinic or hospital. Every API request acts in one organization: the one its credential belongs to. See Organizations.
- Agents are the AI that talks for you. An agent is
voice, for phone calls, ortext, for WhatsApp and web chat. - Channels are where agents work: a WhatsApp number, a phone number or a chat widget on your site. You assign the agent that answers on each.
- Conversations happen on a channel, between an agent, your team and a contact: the patient, with their phone numbers, emails and identity documents.
- Definitions and facts are the data agents capture. A definition says what to capture; a fact is its value for one contact or one conversation.
- Knowledge is the documents agents consult before they answer.
- Campaigns have a voice agent call a list of people. Templates open WhatsApp conversations. Bulletins tell agents what is happening for a while, such as a closed day.
- Evaluations test a change to an agent on past replies your team corrected, before it reaches patients.
- Reports, the change history and tasks give you the numbers, who changed what, and the work that runs in the background.
Where each part is described
| Part | Explained in | API reference |
|---|---|---|
| Agents | Agents | Agents, Voices |
| Channels | Channels | Channels |
| Conversations | Conversations | Conversations |
| Contacts, contact profiles, do-not-contact rules | Contacts | Contacts, Profiles, Suppressions |
| Knowledge | Knowledge | Knowledge |
| Campaigns, templates, bulletins | Campaigns, templates and bulletins | Campaigns, Templates, Bulletins |
| Evaluations | Evaluations | Eval cases, Eval runs |
| Definitions, facts, reports, changes, tasks | Data, reports and tasks | Definitions, Facts, Reports, Changes, Tasks |
| The organization and its team | Below | Organization, Members, Roles |
Calling the Raíz API
Every operation lives under https://api.getarbol.com/v1/raiz/ and is named raiz.<resource>.<verb>, such as raiz.agents.create. Every one accepts people and machines alike, so an API key with the right scopes can call any of them.
Permissions are scopes named after the resource, such as raiz:agents:read and raiz:agents:write, and most reads also accept the write scope. A few resources borrow another’s scopes: bulletins use the agents scopes, and evaluations need an agents scope and a conversations scope. Each operation’s reference page lists exactly which scopes it accepts.
Lists page with cursors (Pagination), and updates that take expectedVersion apply only if nobody changed the record since you read it, answering 409 VERSION_CONFLICT otherwise (Retries).
The organization
raiz.organization.get reads your organization as Raíz sees it: its name, its agents’ default language, its timeZone, in which reports count days and campaigns run by default, and its settings:
| Setting | What it does |
|---|---|
channels.maxConcurrentOutboundCalls |
How many campaign calls run at once (default 5). |
notifications |
Whether to email up to 10 recipients when the AI hands a conversation to the team (escalations), when it couldn’t answer (failures), or when a closed conversation’s request wasn’t resolved (failedOutcomes). phones also get the handoff notice on WhatsApp. All off by default. |
dailyReport |
Whether to email a daily report, at sendAt, to up to 10 recipients: the last 24 hours’ calls and conversations, those waiting for your team and those to review. Off by default. |
raiz.organization.update changes the name, language, time zone and settings: an omitted setting stays as it is, and null returns it to its default. raiz.organization.sendDailyReport sends the daily report now. Account manages the organization’s team and its roles through account.members.list and account.roles.list.
Start here
To see the parts working together, create an agent and put it on a channel. Then read Conversations to follow what it does.