Sign inGet Started

bird whatsapp agents websites create

Usage

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

Description

Add a website to an agent

Give the agent on this WhatsApp number a website to learn from. WhatsApp reads it in the background, so check the entry's crawl_status with bird whatsapp agents websites get before expecting answers from it.

Build the request from the <url> argument, a JSON WhatsAppAgentWebsiteCreate body via --body-file ("-" reads stdin), or both — an inline value 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 websites create --example

# the body it prints:
Code example
{
  "url": "https://example.com/help/delivery"
}

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
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp agents websites deleteRemove one of an agent's websites
bird whatsapp agents websites getGet one of an agent's websites
bird whatsapp agents websites listList an agent's websites
bird whatsapp agents websites updateChange the address of one of an agent's websites

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