Enter REST API key. To generate a key, go to Settings â Knowledge base portal â API tokens
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": [
{
"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",
"order": 5,
"is_draft": false,
"exclude": false,
"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
}
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
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
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
algolia search object ID
Markup text with occurrences highlighted.
Indicates how well the attribute matched the search query. Can be: none, partial, full
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.
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information
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": []
}
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information