Get the document
Get the document
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Targeted document
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Headers
Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json
Default:application/json
Response
Response
Document
Document
a document
the id of the document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
the id of the parent document
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
the slug of the document
Example:getting-started
document publish status. Default to published.
Allowed values:publishedunpublished
revision of a document
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Headers
Delete the document
Delete the document.
Returns 404 if the document cannot be found, 409 if deleting the document would result in other orphaned documents.
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Targeted document
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Response
Response
The document has been deleted
Authentication
Path Parameters
Update the document
Update the document
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Targeted document
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Body
application/json
Body
document update
UpdateDocumentPayload
a document payload
Parent document Id. If this value is explicitly set to null, the
document will be put as a top level document at the bottom of the tree.
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
document publish status. Default to published.
Allowed values:publishedunpublished
document title
Example:How to update a document in Konnect DocumentHub
base64 encoded string of the document content
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
markdown content
Example:## My Markdown
name of the uploaded file
Example:my_doc.md
Contains key value pairs information about entity’s metadata.
Response
application/json
Response
The document has been updated
Document
a document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
document publish status. Default to published.
Allowed values:publishedunpublished
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
revision of a document
Show Child Parameters
Authentication
Path Parameters
Body
Move a document
This api allows the user to move a document within the document tree using the
parameters parent_document_id and index. If parent_document_id is not
provided, the document will be placed at the top level of the document tree.
index represents a zero-indexed document order relative to its siblings under
the same parent. For example, if we want to put the document at top level in
first position we would send parent_document_id: null and index: 0. This api
also supports using a negative index to count backwards from the end of the
document list, which means you can put the document in last position by using
index: -1.
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Targeted document
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Body
application/json
Body
move document
Move document
move document request payload
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
index of the document in the parent document’s children
Example:1
Response
Response
The document has been moved
Authentication
Path Parameters
Body
ListDocumentsTree
objectreturns the pagination information
Show Child Parameters
a document tree