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 project version
The language code of the article
The phrase to search across all articles in the project version
Specify the page to retrieve. Page numbers are zero-based. Therefore, to retrieve the 10th page, you need to set page=9
Number of results per page
Success
200 response in searches for a phrase inside project version
{
"data": {
"hits": [
{
"title": "Understanding Home page builder",
"content": "The home page is the first page an end-user will see when they visit your knowledge base. The Home Page Builder lets you customize your home page by adding links, changing colors, including categories from your knowledge base, and more. \n The home page builder comes with an intuitive interface to design a professional looking front-page to your knowledge base. You do not need any developer support to create a good looking home page. \n If you do not want a home page and would like to direct the user directly to the real content, you can easily turn off the home page for your knowledge base. \n \n \n This is a sample article, you can safely delete it. \n \n",
"is_hidden": false,
"tags": [],
"slug": "understanding-home-page-builder",
"version": 1,
"article_id": "6116080f-5b38-4037-b878-82d318543dsw",
"category_id": "6116080f-5b38-4037-b878-82d318543af",
"is_category_hidden": null,
"order": 5,
"is_draft": false,
"exclude": false,
"breadcrumb": null,
"is_category": null,
"attachment_ids": null,
"is_deleted": null,
"is_folder_type_category": null,
"updated_on_timestamp": null,
"is_private": null,
"language_id": null,
"project_id": null,
"is_latest_version": null,
"contributors": null,
"is_shared_article": null,
"lang_code": null,
"category_unique_id": null,
"unique_id": null,
"deleted_by": null,
"deleted_at": null,
"is_git_hub_entity": null,
"original_article_id": null,
"object_id": "",
"_snippet_result": {
"content": {
"value": " The home page is the first page an end-user will see when they visit your knowledge base. The Home Page Builder lets you customize your home page by adding links, changing colors, including categories from your knowledge base, and more. \n The home page builder comes with an intuitive",
"match_level": ""
}
},
"_highlight_result": {
"title": null
}
}
],
"nb_hits": null,
"page": null,
"nb_pages": null,
"hits_per_page": null,
"processing_time_ms": null,
"query": null
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}The list of articles that matched the search query.
Article title
Article HTML content
Indicates if the article is visible on the site
Custom article tags
The slug of the article
The version number that is currently published
The ID of the article
The ID of the category
Indicates if category is visible on the site
The position inside the parent category
Indicates if the article is marked as a draft
Indicates if the article is excluded from search results on user website
The breadcrumb of the article
If the value is True, then the object has to considered as a category, otherwise it is an article
The IDs of the files attached to the article
If the value is True, then it indicates that the article has been deleted
If the value is True, then it indicates that the category is a folder type category
The last updated timestamp of the article
If the value is True, then the article can only be accessed by logged in users in the knowledge base site
The ID of the language
The ID of the project
If the value is True, then the article is the latest version
The IDs of users who have contributed to the article
If the value is True, then it indicates that it is a shared article
The language code of the article or category
A unique identifier for the category which is a combination of category ID and the language code
A unique identifier for the article which is a combination of article ID and the language code
The ID of the user who deleted the article
The timestamp when the article was deleted
If the value is True, then it indicates that the article is synced from GitHub
The original article ID. Applicable only for shared articles.
algolia search object ID
Markup text with occurrences highlighted.
Markup text with occurrences highlighted.
Indicates how well the attribute matched the search query. Can be: none, partial, full
Highlighted attributes
Markup text with occurrences highlighted.
Indicates how well the attribute matched the search query. Can be: none, partial, full
List of words from the query that matched the object.
The number of hits (articles) matched by the query.
The position of the current page (zero-based).
The number of returned pages. Calculation is based on the total number of hits (nbHits) divided by the number of hits per page (hitsPerPage), rounded up to the nearest integer.
Maximum number of hits (articles) per page.
The time the server took to process the request, in milliseconds. This doesn’t include network time.
The query used to search the articles.
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
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.
Warnings in the customer API response
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.
Information passed by the customer API response
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
400 bad response due to invalid Project version Id
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The supplied project version id does not exist in your project",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}400 bad response due to invalid Language Code
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid Language code",
"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.