API Reference

API keys

Create, list and revoke API keys, and check which account, organization or user a key acts for. A new key is shown once.

Users

The end users of your app. You provision users by email, and everything a user owns (tasks, chats, memories, contacts) is isolated to that user. Errors common to every user-scoped call are listed in the Authentication guide.

User setup

A user's profile and setup. Calls made as a user return `428 onboarding_required` until you set a timezone and working hours and mark setup complete.

Assistants

An assistant's identity: name, personality, writing style, email address and phone lines. A user can have several assistants, one of them primary.

Identifiers

The phone numbers and email addresses that belong to a user, so inbound messages and calls reach the right person.

Tasks

Durable units of work. A task can run for days, wait on other people and resume when they reply.

Chats

Conversations between a user and an assistant. Add a message, then process the chat to get the assistant's reply.

Approvals

Actions the assistant staged for a person to review before they go out. The API calls a batch of staged actions a cart. Show the approval to the user, then approve it with its `contentHash` so exactly what they saw is sent.

Autonomy

Per-user settings for how freely the assistant acts on each kind of outbound action (`auto`, `time-boxed` or `manual`), plus per-recipient exceptions. A team, organization or the account can lock a setting so lower levels can only tighten it.

Skills

Packaged capabilities your assistants use: instructions, connected tool servers and recurring workflows.

Memories

Facts and preferences the assistant saves and recalls for each user.

Contacts

The people a user works with, across email, phone and chat, with relationships and external ids.

Files

Each user's file storage. Upload a file in three steps (create an upload, PUT the bytes, confirm), then attach it to a task or message by id.

Workspace

Each user's cloud computer, with a browser, desktop and shell, that the assistant uses for sites and apps without an API. When the assistant needs the user, for example to sign in, it opens a handoff, and the user takes over the live browser and hands it back.

Organizations

Your customers' companies. Each organization has members, verified domains, SSO, audit events and policy that its teams inherit.

Teams

Groups of users in your account, inside an organization or on their own. Team admins adjust settings for their team wherever a higher level has not locked them.

Voice

Live voice sessions, call history, voice engines and phone line requests.