business_knowledge

Read-only access to parsed knowledge documents. Exposes hybrid search (search) and a drill-down window (window) so an agent (PHAI or MCP) can find and explore business knowledge chunks.

get/api/projects/{project_id}/business_knowledge/documents/{id}/window/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/business_knowledge/documents/{id}/window/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this knowledge document.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

around_ordinalinteger required

Zero-based chunk ordinal to center the window on (from a search result).

radiusinteger

Number of chunks before and after the center to include. Defaults to 5, clamped to [0, 15].

Response

chunk_idstring uuid required

Stable identifier of this chunk. Same value used in search results.

ordinalinteger required

Zero-based position of this chunk within its document. Use it as around_ordinal to recenter the window.

contentstring required

The chunk's text content.

heading_pathstring required

Breadcrumb of section headings this chunk sits under. Empty when the document has no heading structure.

source_namestring required

Human label of the knowledge source this chunk belongs to.

document_titlestring required

Title of the document this chunk belongs to.

urlstring required

Fetched page URL. Empty for text and file sources.

Changes

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