Skip to main content
POST
Add Meta agent website

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

connection_id
string
required

The ID of the connection

phone_number_id
string
required

The ID of the WhatsApp phone number the Meta agent runs on

Body

url
string<uri>
required

The site to crawl. The whole domain is crawled by default.

included_sub_domains
string[]
Maximum array length: 100
Maximum string length: 256
included_url_patterns
string[]
Maximum array length: 100
Maximum string length: 256
excluded_sub_domains
string[]
Maximum array length: 100
Maximum string length: 256
excluded_url_patterns
string[]
Maximum array length: 100
Maximum string length: 256
single_urls
string<uri>[]
Maximum array length: 100

Response

200 - application/json
id
string
required
url
string
required
crawl_status
enum<string>
required
Available options:
not_started,
pending,
in_progress,
completed,
completed_no_data,
failed
crawl_error
string
pages_crawled
number
last_crawled_at
string
created_at
string
included_sub_domains
string[]
included_url_patterns
string[]
excluded_sub_domains
string[]
excluded_url_patterns
string[]
single_urls
string[]