Skip to main content
POST
Read a business's own pages

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Body

application/json
websiteId
string
required

A website you can edit; its organization pays for the call in AI credits.

Minimum string length: 1
urls
string<uri>[]
required

One to ten absolute public URLs of the business's own pages: its site, its Google listing, its Instagram, Facebook, Yelp, Booksy, Nextdoor, Etsy, or any other profile. Read in parallel.

Required array length: 1 - 10 elements
Maximum string length: 2048
objective
string

What the profile is for; the write-up leans toward it.

Required string length: 1 - 5000
images
boolean
default:false

Also return the page's own photos (avatar, cover, posts, gallery, menu) with their rights and expiry. Only for a business the user confirmed as theirs.

Response

One profile per page, with contact sheets.

results
object[]
required
sheets
object[]