Sign inGet Started

bird whatsapp agents skills create

Usage

Code example
bird whatsapp agents skills create <number-id> [flags]

Description

Add a skill to an agent

Give the agent on this WhatsApp number a skill: when a situation applies, and what to do then. It reaches WhatsApp before this returns and is used from the next conversation turn.

Build the request from flags, a JSON WhatsAppAgentSkillCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example
# print the body shape (no credentials needed)
bird whatsapp agents skills create --example

# the body it prints:
Code example
{
  "description": "A contact asks to cancel, change or return an order they have already placed.",
  "skill": "Ask for the order number. Tell the contact the cancellation window is 24 hours from ordering. If it has passed, offer a return instead and explain the 30-day return policy.",
  "title": "cancel-order"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--titleA short handle for the skill, in lowercase letters, digits and hyphens. It is for you to tell skills apart; the agent reads description and skill. (required; or in --body-file)
--descriptionWhen the agent should use this skill. Keep it to the trigger; what to do goes in skill. (required; or in --body-file)
--skillWhat the agent does when the skill applies, as an instruction to the agent rather than a fact about the business, which is what business_info and the questions and answers are for. (required; or in --body-file)
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp agents skills deleteRemove one of an agent's skills
bird whatsapp agents skills getGet one of an agent's skills
bird whatsapp agents skills listList an agent's skills
bird whatsapp agents skills updateUpdate one of an agent's skills

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