OpenMax
Free Trial

Apps API · KB Pages

KB Pages: 16 endpoints

← All groups

POST /api/v1/kbs/{kb_id}/pages

Create page

Scope: kb:page:write · Called with: appToken · operationId: create-kb-page

Required app scope: kb:page:write.

Creates a KB page. Response wrapped in standard envelope. A knowledge base that does not exist, was deleted, or is not visible to the caller answers 404 KB_NOT_FOUND (meta.kb_id); a missing parent folder in a live knowledge base answers 404 KB_ERROR.

Parameters

Name In Type Required Description
kb_id path string (uuid) yes KB UUID

Request body

application/json · CreatePageRequestBody

Field Type Required Description
body string yes Page content body
format string: markdown, plain_text yes Page format
message string Revision message
parent_id string (uuid) Parent node UUID
title string yes Page title

Responses

GET /api/v1/pages

List pages

Scope: kb:page:read · Called with: appToken · operationId: list-pages

Required app scope: kb:page:read.

Returns pages. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
limit query integer (int32) Items per page (default: 20, max: 100)
offset query integer (int32) Number of items to skip (default: 0)
cursor query string Opaque cursor from previous page

Responses

GET /api/v1/pages/trashed

List trashed pages

Scope: kb:page:read · Called with: appToken · operationId: list-trashed-pages

Required app scope: kb:page:read.

Returns trashed pages. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
limit query integer (int32) Items per page (default: 20, max: 100)
offset query integer (int32) Number of items to skip (default: 0)

Responses

DELETE /api/v1/pages/{page_id}

Permanently delete page

Scope: kb:page:delete · Called with: appToken · operationId: permanent-delete-page

Required app scope: kb:page:delete.

Permanently deletes a page. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Responses

GET /api/v1/pages/{page_id}

Get page

Scope: kb:page:read · Called with: appToken · operationId: get-page

Required app scope: kb:page:read.

Returns a page. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Responses

PATCH /api/v1/pages/{page_id}

Update page metadata

Scope: kb:page:write · Called with: appToken · operationId: update-page-metadata

Required app scope: kb:page:write.

Updates page metadata. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Request body

application/json · UpdatePageMetadataRequestBody

Field Type Required Description
title string Page title

Responses

GET /api/v1/pages/{page_id}/content

Get page content

Scope: kb:page:read · Called with: appToken · operationId: get-page-content

Required app scope: kb:page:read.

Returns page content. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Responses

PUT /api/v1/pages/{page_id}/content

Update page content

Scope: kb:page:write · Called with: appToken · operationId: update-page-content

Required app scope: kb:page:write.

Updates page content. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Request body

application/json · UpdatePageContentRequestBody

Field Type Required Description
auto_save boolean yes Whether this is an autosave update
base_revision_id integer (int64) Expected base revision ID
body string yes Page content body
message string Revision message

Responses

POST /api/v1/pages/{page_id}/freeze

Freeze page

Scope: kb:page:write · Called with: appToken · operationId: freeze-page

Required app scope: kb:page:write.

Freezes page content. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Responses

GET /api/v1/pages/{page_id}/references

List page references

Scope: kb:page:read · Called with: appToken · operationId: list-page-references

Required app scope: kb:page:read.

Returns page references. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Responses

POST /api/v1/pages/{page_id}/restore

Restore page from trash

Scope: kb:page:write · Called with: appToken · operationId: restore-page-from-trash

Required app scope: kb:page:write.

Restores a trashed page. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Responses

GET /api/v1/pages/{page_id}/revisions

List page revisions

Scope: kb:page:read · Called with: appToken · operationId: list-page-revisions

Required app scope: kb:page:read.

Returns page revisions. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID
limit query integer (int32) Items per page (default: 20, max: 100)
offset query integer (int32) Number of items to skip (default: 0)

Responses

GET /api/v1/pages/{page_id}/revisions/diff

Diff page revisions

Scope: kb:page:read · Called with: appToken · operationId: diff-page-revisions

Required app scope: kb:page:read.

Returns a diff between page revisions. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID
from_revision query integer (int64) yes Base revision ID
to_revision query integer (int64) yes Target revision ID

Responses

GET /api/v1/pages/{page_id}/revisions/{revision_id}

Get page revision

Scope: kb:page:read · Called with: appToken · operationId: get-page-revision

Required app scope: kb:page:read.

Returns page revision content. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID
revision_id path integer (int64) yes Revision ID

Responses

POST /api/v1/pages/{page_id}/revisions/{revision_id}/restore

Restore page version

Scope: kb:page:write · Called with: appToken · operationId: restore-page-version

Required app scope: kb:page:write.

Restores a page to a revision. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID
revision_id path integer (int64) yes Revision ID

Responses

POST /api/v1/pages/{page_id}/trash

Trash page

Scope: kb:page:write · Called with: appToken · operationId: trash-page

Required app scope: kb:page:write.

Moves a page to trash. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
page_id path string (uuid) yes Page UUID

Responses