Voice

Attach a web source and crawl it now

Crawl a site into this collection, now and then on a schedule.

THE FIRST CRAWL STARTS IMMEDIATELY. It does not wait for the cadence, so creating a source with frequency: manual still crawls once. Up to max_pages pages are fetched and embedded, and both cost money - which is why this is billable and voice guards it with its EXPENSIVE rate limit.

frequency is closed to voice's four cadences here. Voice itself takes a bare string and only its scheduler notices an unknown one, so an invented value there produces a source that quietly never re-crawls.

post/voice/collections/{collection_id}/scrape-sources

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/voice/collections/{collection_id}/scrape-sources
  • Auth: HTTP bearer

Path parameters

collection_idinteger required

Collection id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

urlstring required

Root URL. Everything under it is followed.

frequency'daily' | 'weekly' | 'monthly' | 'manual'

How often to re-crawl. manual never re-crawls.

max_pagesinteger

Ceiling, not a target - a small site only crawls what exists.

Response

Successful Response

dataVoicePayload required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

Changes

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