Pages
Operations of the Knowledge Base API. Paths are relative to your deployment's API host.
GET /api/knowledge-base-api/pages/search
Search pages across all spaces
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | string | no | Maximum number of results |
q | query | string | no | Search query string (omit to list recent pages) |
sourceType | query | one of "authored", "ingestion_chunk", "ingestion_summary" | no | Filter by source type |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageResponseDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/knowledge-base-api/pages/{pageId}
Get a page by ID
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageId | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/knowledge-base-api/pages/{pageId}/route
Resolve a page id to its (spaceSlug, pageSlug) route
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageId | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageRouteResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/knowledge-base-api/spaces/{spaceSlug}/pages
List pages in a space
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
spaceSlug | path | string | yes | |
limit | query | number | no | |
page | query | number | no | |
parentId | query | string | no | Filter by parent page ID (null for root pages) |
search | query | string | no | Full-text search query |
sourceType | query | one of "authored", "ingestion_chunk", "ingestion_summary" | no | Filter by source type (defaults to "authored" to hide ingestion chunks) |
spaceSlug | query | string | no | Filter by space slug |
status | query | one of "published", "proposed", "rejected" | no | Filter by exactly one page status. Omitted, the listing returns every status EXCEPT "rejected" — the tombstone this service writes when a pipeline run is rejected wholesale. Passing status=rejected is the explicit opt-in that surfaces those tombstones. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageResponseDtoPaginatedEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/knowledge-base-api/spaces/{spaceSlug}/pages
Create a new page in a space
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
spaceSlug | path | string | yes |
Request body: application/json CreatePageDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json PageResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/knowledge-base-api/spaces/{spaceSlug}/pages/bulk
Bulk upsert pages — create or update by externalId/slug
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
spaceSlug | path | string | yes |
Request body: application/json BulkUpsertPagesDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json BulkUpsertPagesResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/knowledge-base-api/spaces/{spaceSlug}/pages/import-from-session
Import an agent session workspace file as a new page, or as a new revision of an existing page
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
spaceSlug | path | string | yes |
Request body: application/json ImportSessionFileDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json PageResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
PATCH /api/knowledge-base-api/spaces/{spaceSlug}/pages/move
Move one or more pages to a new parent (or root)
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
spaceSlug | path | string | yes |
Request body: application/json MovePageDto
| Status | Description | Body |
|---|---|---|
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/knowledge-base-api/spaces/{spaceSlug}/pages/tree
Get page tree for a space
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
spaceSlug | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageTreeNodeDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
PUT /api/knowledge-base-api/spaces/{spaceSlug}/pages/{pageId}
Update a page (creates new version)
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageId | path | string | yes | |
spaceSlug | path | string | yes |
Request body: application/json UpdatePageDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
DELETE /api/knowledge-base-api/spaces/{spaceSlug}/pages/{pageId}
Delete a page by ID
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageId | path | string | yes | |
spaceSlug | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/knowledge-base-api/spaces/{spaceSlug}/pages/{pageId}/propose
Propose an edit to a page (creates proposal for human-authored pages)
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageId | path | string | yes | |
spaceSlug | path | string | yes |
Request body: application/json UpdatePageDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json PageResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/knowledge-base-api/spaces/{spaceSlug}/pages/{pageId}/versions
Get version history for a page
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageId | path | string | yes | |
spaceSlug | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageVersionResponseDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/knowledge-base-api/spaces/{spaceSlug}/pages/{pageId}/versions/{version}
Get specific version content
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageId | path | string | yes | |
spaceSlug | path | string | yes | |
version | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageVersionResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/knowledge-base-api/spaces/{spaceSlug}/pages/{pageSlug}
Get a page by slug
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
pageSlug | path | string | yes | |
spaceSlug | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json PageResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |