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.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

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

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/accounts/{accountId}/business-agent/websites
  • Auth: HTTP bearer

Path parameters

accountIdstring required

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

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

urlstring uri required
single_urlsstring[]

Crawl only these exact pages instead of the whole site.

excluded_sub_domainsstring[]
included_sub_domainsstring[]
excluded_url_patternsstring[]
included_url_patternsstring[]

Only URLs containing one of these substrings are ingested.

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.