Create a knowledge document

Creates a new knowledge document scoped to your company. Optionally associates the document with a board (aptletUuid), a card (aptletInstanceId), or a parent document (parentId).

HTML content is accepted and stored internally as a structured document format.

POST /api/knowledge/create

Create a knowledge document

cURL

curl --request POST \
  --url https://core-api.getaptly.com/api/knowledge/create \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "name": "Lease Addendum Policy",
  "html": "<p>This policy applies to all lease agreements...</p>",
  "accessType": "private"
}
'

201

{
  "_id": "<string>",
  "name": "<string>"
}

Authorizations

x-token · string · header · required

Body

application/json

name · string · required

Document title.

html · string

Initial HTML content for the document body.

aptletUuid · string

UUID of the board to associate this document with.

aptletInstanceId · string

Card ID to link this document to. Creates a reference on the card.

parentId · string

ID of a parent knowledge document (for nested pages).

accessType · enum<string>

Access level. Defaults to public.

Available options: public, private

Response

201

application/json

Document created.

_id · string

ID of the created document.

name · string