Delete collection
Delete the document collection
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Response
Response
The document collection has been deleted
Authentication
Path Parameters
Documents
document operations
List collection documents
List documents in a collection
Query Parameters
Sorts a collection of documents.
The sort parameter is only applied for ‘application/json’ content-type.
Supported sort attributes are:
- created_at
- updated_at
- slug
- title
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter documents returned in the response.
Show Child Parameters
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Headers
Allowed values:application/jsonapplication/vnd.konnect.document-tree+json
Default:application/json
Response
Response
Documents in the collection
ListDocuments
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Headers
Create document
Create document and put it in a collection
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Body
application/json
Body
document creation
CreateDocumentPayload
a document payload
parent document id
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 create a document in Konnect DocumentHub
Must be a base64 encoded string. Either raw_content or str_mdr_content are required.
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
Markdown content. Either raw_content or str_mdr_content are required.
Example:## My Markdown
Contains key value pairs information about entity’s metadata.
Example:{"owner":"John Appleseed"}
name of the uploaded file
Example:my_doc.md
Response
application/json
Response
The document has been created
Document Creation Response Payload
a document payload
document id
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
revision id
Example:ecfb698d-77a8-4ab5-91fa-45ee383b48ba
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
Body
Get a document by slug
Get a document
Query Parameters
Unique slug of the document.
Example:/about/company
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Response
application/json
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