Sync

Re-crawl a single page

Re-crawl one page and replace it in the project's search index, without touching the rest of the index. Returns immediately with 202; the crawl runs in the background.

Use this when one page changed. To re-crawl every source in the project, use POST /api/v2/projects/{slug}/sync/ instead.

Requirements

  • The URL must be on a host Biel.ai already crawls for this project: one of its embed domains, or the host of one of its URL or sitemap sources. Host matching is exact. A URL on any other host returns 400, which keeps the endpoint from being used as a fetch-anything proxy.
  • The project must have been indexed at least once. Run a full sync first, until then this endpoint returns 409.

A page the index doesn't hold yet is added rather than replaced, and counts against your plan's page limit.

Result reporting

The 202 means the page was accepted and queued, not that it was indexed. The background job is fire-and-forget: if the page can't be fetched, is excluded by the project's URL filters, or produces no indexable content, the run is dropped and no status is reported back. The next call, or the next full sync, is the retry. Use GET /api/v2/projects/{slug}/search/ to confirm the new content is in the index.

Required permission: sync_create

post/api/v2/projects/{slug}/recrawl/

Request

  • Base URL: https://app.biel.ai
  • URL: https://app.biel.ai/api/v2/projects/{slug}/recrawl/
  • Auth: API key in header Authorization

Path parameters

slugstring required

Project slug identifier.

Request body

urlstring uri required

Absolute http or https URL of the page to re-crawl. The host must be one Biel.ai already crawls for this project: an embed domain, or the host of one of its URL or sitemap sources. Host matching is exact, so docs.example.com does not cover blog.example.com.

Example request

{
  "url": "https://docs.example.com/guide/"
}

Response

Page accepted and queued for crawling.

status'queued' required

Always queued. The crawl itself runs in the background.

urlstring uri required

The URL that was queued, echoed back.

Example response

{
  "status": "queued",
  "url": "https://docs.example.com/guide/"
}

Changes

No recorded changes to this operation across all 1 revision of this API.