Sign inGet Started

bird whatsapp agents

Usage

Code example
bird whatsapp agents

Description

An agent belongs to one number, starts off, and answers from its settings, business info, FAQs, websites, files and skills. Every change applies to the live agent on the next conversation turn. test asks it a question without reaching a contact.

Reads return JSON; list is paginated. Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request. Destructive commands require --yes.

Commands

NameDescription
allowlistChoose the contacts an agent answers while its audience is the allowlist
business-infoRead and change what an agent knows about the business
createOnboard an agent on a WhatsApp number
deleteDelete a WhatsApp number's agent
faqsManage the questions and answers an agent answers from
filesUpload, read and remove the documents an agent answers from
getGet a WhatsApp number's agent
listList WhatsApp numbers with their agent state
notificationsTell an agent about something that happened to one contact
settingsRead and change how an agent behaves
skillsManage what an agent does in situations you describe
testSend an agent a test message
ui-skillsManage the rich-message components an agent may answer with
websitesManage the web pages an agent learns from

Continue with the documentation, guides and examples for this topic.