Sign inGet Started

bird whatsapp agents files upload

Usage

代码示例
bird whatsapp agents files upload <number-id> [flags]

Description

Upload a file to an agent

Upload a document for the agent on this WhatsApp number to answer from, as multipart form data with file_name and file parts. Up to 100 MB; PDF, Word, PNG, JPEG, CSV or Excel.

Pass the file with --file ("-" reads stdin); any other fields are flags. Run --dry-run to print the parts that would be sent, including the file's path and size, without uploading it.

Examples

代码示例
# check what would be sent, without sending it
bird whatsapp agents files upload <number-id> --file-name <file-name> --file ./document.pdf --dry-run

# upload it
bird whatsapp agents files upload <number-id> --file-name <file-name> --file ./document.pdf

Options

Request

NameDescription
--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
--file-nameThe name to file the document under. WhatsApp lists the file by it, and so does this API. (required)
--fileThe document itself, up to 100 MB. WhatsApp accepts PDF, Word (.doc, .docx), PNG, JPEG, CSV and Excel (.xlsx); anything else is refused with 422. (required)
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird whatsapp agents files deleteRemove one of an agent's files
bird whatsapp agents files downloadDownload one of an agent's files
bird whatsapp agents files getGet one of an agent's files
bird whatsapp agents files listList an agent's files