Skip to content

Pages API

Pages are indexed URLs. The API exposes only pages belonging to the bearer client’s project and assigned sources.

List pages

GET /api/pages?limit=50
Authorization: Bearer CLIENT_ID.CLIENT_SECRET
Query parameter Required Description
limit No Number of items to return, from 1 to 100. Defaults to 50.

200 OK returns newest updated pages first:

{
  "items": [
    {
      "id": "pg_abc",
      "url": "https://example.com/help/",
      "title": "Help centre",
      "source_id": "src_123",
      "status": "ready",
      "status_error": null,
      "has_triggers": true,
      "updated_at": "2026-09-11T09:20:00+00:00"
    }
  ]
}

status is the current indexing state. status_error is populated only when processing reports an error. has_triggers reports whether trigger content is present for that page; it does not enable or disable the widget.

Get one page

GET /api/pages/{page_id}
Authorization: Bearer CLIENT_ID.CLIENT_SECRET
Path parameter Description
page_id The page ID returned by GET /api/pages.

The response has the same object shape as an item in the list. A page outside the client’s assigned sources is returned as 404, without revealing its project or source.

Queue a URL for crawling

Use Update API (POST /api/update) to add a URL to the crawl queue or request reprocessing. See that reference for parameters, examples, and error responses.