DocumentTree

object

a document tree

idstring(uuid)required

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

parent_document_idstring(uuid)

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

titlestringrequired
filenamestringrequired

Example:myDocument.md

slugstringrequired

document slug

Example:path-for-seo

metadataobjectrequired

Contains key value pairs information about entity’s metadata.

Example:{"owner":"John Appleseed"}

* Additional properties are allowed.
statusstringrequired

document publish status. Default to published.

Allowed values:publishedunpublished

childrenarray[object]required

a document tree

Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","title":"Hello world","filename":"myDocument.md","slug":"hello-world","status":"published","created_at":"2023-01-11T02:30:42.227Z","updated_at":"2023-01-11T02:30:42.227Z","metadata":{"author":"John Doe"},"children":[]}

Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

Revision

object

revision of a document

idstring(uuid)required

revision id

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

document_idstring(uuid)required

document id

Example:2272b454-4af6-4c56-8a02-d6145ac62e67

contentobjectrequired

content of the document

Example:{"type":"document","content":[{"type":"paragraph","content":[{"text":"Hello World","type":"text"}]}]}

Show Child Parameters
metadataobjectrequired

Contains key value pairs information about entity’s metadata.

Example:{"owner":"John Appleseed"}

* Additional properties are allowed.
titlestringrequired

Example:Hello world

raw_md_contentstring(byte)

raw markdown content

Example:I0ludHJvZHVjdGlvbg==

fileobjectrequired

file of the revision

Show Child Parameters
Example

CreateCollectionPayload

object

payload to create the document collection

namestringrequired
Example

UpdateCollectionPayload

object

payload to update the document collection

namestringrequired
Example

CreateDocumentPayload

object

a document payload

parent_document_idstring(uuid)

parent document id

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

statusstring

document publish status. Default to published.

Allowed values:publishedunpublished

titlestringrequired

document title

Example:How to create a document in Konnect DocumentHub

raw_contentstring(byte)

Must be a base64 encoded string. Either raw_content or str_mdr_content are required.

Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=

str_md_contentstring

Markdown content. Either raw_content or str_mdr_content are required.

Example:## My Markdown

metadataobject

Contains key value pairs information about entity’s metadata.

Example:{"owner":"John Appleseed"}

* Additional properties are allowed.
filenamestringrequired

name of the uploaded file

Example:my_doc.md

Example