`bird whatsapp agents faqs create`

Usage

Code example

bird whatsapp agents faqs create <number-id> [flags]

Description

Add a question and answer to an agent

Give the agent on this WhatsApp number one more question and answer to work from. It reaches WhatsApp before this returns and is used from the next conversation turn.

Build the request from flags, a JSON WhatsAppAgentFAQCreate 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 faqs create --example

# the body it prints:

Code example

{
  "answer": "Orders placed before 16:00 on a working day arrive the next working day in the Netherlands and Belgium.",
  "question": "How long does delivery take?"
}

Options

Request

Name	Description
`--body-file`	Read the JSON request body from this file; "-" reads stdin
`--example`	Print a complete example request body, then exit
`--dry-run`	Print the resolved request without sending it, then exit
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
`--question`	The question a contact might ask, in their words rather than yours. (required; or in --body-file)
`--answer`	What the agent answers. It is rewritten to fit the conversation rather than quoted, so write the fact and not the phrasing. (required; or in --body-file)
`--metadata <key=value>`	Your own labels on this entry.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird whatsapp agents faqs delete`	Remove one of an agent's questions and answers
`bird whatsapp agents faqs get`	Get one of an agent's questions and answers
`bird whatsapp agents faqs list`	List an agent's questions and answers
`bird whatsapp agents faqs update`	Update one of an agent's questions and answers

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

Get an implementation brief

Related resources