Skip to main content
POST
Add website knowledge
Required scope: AGENTS_WRITE

Behavior

Adds a page to the receptionist’s knowledge. Allo scrapes it and summarizes it during the request, so this call takes a few seconds and returns 201 with the entry once the page has been read. Send an absolute http(s) URL of a publicly reachable page. A receptionist holds up to 5 websites, and the same URL cannot be added twice. The response never carries the scraped text. That text is what the receptionist reads, not something you configure. Point it at the page that carries the answers, not at the site root. Only the page you send is read.

Errors

  • 400 INVALID_KNOWLEDGE_URL: the URL is malformed or cannot be scraped.
  • 409 AGENT_KNOWLEDGE_ALREADY_EXISTS: this receptionist already has an entry for that URL.
  • 409 AGENT_KNOWLEDGE_LIMIT_REACHED: the receptionist already holds 5 websites. Delete one first.
  • 500 AGENT_KNOWLEDGE_SCRAPE_FAILED: the page could not be read. This one is retryable, so try again in a few seconds and check the page is publicly reachable.
  • 404 PHONE_NUMBER_NOT_FOUND: the number is not one you have access to.

Authorizations

Authorization
string
header
required

Path Parameters

number
string
required

Allo phone number in E.164 format

Example:

"+14155551234"

Body

application/json
url
string
required

An absolute http(s) URL of a publicly reachable page.

Example:

"https://acme.test/pricing"

Response

The entry that was created

data
object

A page Allo scraped and summarized for the receptionist to answer from. The scraped text itself is not reported: it is what the receptionist reads, not something you configure.