The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
The ID of the category
Language code of the category
Success
Getting settings status for category.
{
"data": {
"slug": "indexpage",
"seo_title": "IndexPage",
"description": null,
"allow_comments": true,
"show_table_of_contents": true,
"featured_image_url": null,
"tags": [],
"status_indicator": 0,
"status_indicator_expiry_date": null,
"exclude_from_search": false,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}This is to get category settings data
The slug of the category
SEO title of the category
SEO description of the category
Allow comments for category
True - Table of Contents will be enabled
False - Table of Contents will be disabled
URL of the featured image
List of Tags associated to the category
Category status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The number of days after which the article status will be removed
true - The caetgory will not appear in search results in the knowledge base false - The category will appear in search results in the knowledge base
true - The AI search assistant will not fetch information from this page category; false - The AI search assistant will not exclude this page category while fetching information
The list of related article IDs to show in the knowledge base
The ID of the article
The title of the article
True indicates that the article is hidden
The slug of the article
0 - Markdown content; 1 - HTML content
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
Kindly verify the Categotry Id and Langauage code, and peroform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Category not found",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.