Add Docs to Product

Additional documentation (Markdown or HTML) can be added to enhance the user’s understanding and experience of API products. These documents are added as table-of-contents entries.

Use the POST Add table of contents entry endpoint to link a Markdown document.

📌 The content type markdown/html distinguishes documentation from API references.

Sample Request

Sample Response

Add Markdown Contents

Use the PATCH Update the contents of a document endpoint to provide actual Markdown content.

🚧 Important: Only Markdown documents can be edited via the API. To modify HTML documents, please use the Portal UI. Additionally, changing the document type through an API request is not supported.

Possible causes if any of your APIs are un-resolvable:

After documentation and API reference are added, the portal may look like:

Nest Pages

Nesting allows you to nest pages for better content structure. Use the parentId field in the request payload to create subpages.

The following parameters are used with the /table-of-contents/{id} endpoint:

Sample Request to Add Subpage

Sample Response