Sign in
Business Agent

Add a website to crawl

Meta crawls the site into the agent knowledge and recrawls it periodically; check crawl_status and crawl_error on read. Not idempotent.

post/v1/accounts/{accountId}/business-agent/websites

Path parameters

accountIdstring required

WhatsApp social account id (the number must be managed through the Cloud API).

Request body

urlstring uri required
included_sub_domainsstring[]
included_url_patternsstring[]

Only URLs containing one of these substrings are ingested.

excluded_sub_domainsstring[]
excluded_url_patternsstring[]
single_urlsstring[]

Crawl only these exact pages instead of the whole site.

Response

Website added

urlstring uri required
included_sub_domainsstring[]
included_url_patternsstring[]

Only URLs containing one of these substrings are ingested.

excluded_sub_domainsstring[]
excluded_url_patternsstring[]
single_urlsstring[]

Crawl only these exact pages instead of the whole site.

idstring required
crawl_statusstring

not_started, pending, in_progress, completed, completed_no_data or failed (see crawl_error).

crawl_errorstring
pages_crawledinteger
last_crawled_atinteger

Unix seconds.

created_atinteger

Unix seconds.

Changes