Allo

Add website knowledge

Adds a website to the receptionist's knowledge. Allo crawls the site from this URL in the background and returns the entry right away; the receptionist can…

POST/v2/api/numbers/{number}/agent/knowledge/websites

Behavior

Adds a website to the receptionist's knowledge. Allo crawls the site starting from the URL you send. The crawl runs in the background, so the call returns 201 right away with the entry (status ACTIVE). The receptionist can answer from the site once indexing has finished. If the crawl fails, the API does not report it.

Send the URL of a publicly reachable site. A URL without http:// or https:// is stored as https://. There is no limit on the number of websites, but the same URL cannot be added twice to a line.

Websites belong to your team's knowledge library. If another line of your team already added that URL, Allo links the existing website to this line instead of crawling it again.

The response never carries the crawled text. That text is what the receptionist reads, not something you configure.

Errors

  • 400 INVALID_KNOWLEDGE_URL: the URL has no public host (for example acme instead of acme.com).
  • 409 AGENT_KNOWLEDGE_ALREADY_EXISTS: this line already uses a website with that URL.
  • 404 PHONE_NUMBER_NOT_FOUND: the number is not one you have access to.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

numberstringrequired

Allo phone number in E.164 format

Body

urlstringrequired

The URL of a publicly reachable site. A URL without a scheme is stored as https://.

Responses

201The entry that was created
dataobject

A website of the team's knowledge library, crawled for the receptionist to answer from. The crawled text itself is not reported: it is what the receptionist reads, not something you configure.

5 fields
idstring
urlstring
statusenum<string>

ACTIVE when this line's receptionist answers from the website, DISABLED when this line does not use it.

ACTIVEDISABLED

created_atstring<date-time> | null
updated_atstring<date-time> | null
400
401
403
404
409
429