curl --request GET \
--url https://{your-subdomain}.neetokb.com/api/external/v2/search \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetokb.com/api/external/v2/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetokb.com/api/external/v2/search"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"matches": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "https://spinkart.neetokb.com/articles/billing-and-invoices",
"title": "Billing and invoices",
"category": "Getting Started",
"category_url": "https://spinkart.neetokb.com/folders/getting-started",
"matched_title": "<span class=article-matched-tag>Billing</span> and invoices",
"matched_content": "Your <span class=article-matched-tag>billing</span> cycle starts on the day you subscribe.",
"matched_category": null
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"current_page_number": 123,
"page_size": 123
}
}Search articles
This API runs a full-text search across the workspace’s published articles. Results are ranked by relevance, with the title weighted highest, then content, slug, category name, and keywords. Each match includes highlighted snippets showing where the search term appears.
curl --request GET \
--url https://{your-subdomain}.neetokb.com/api/external/v2/search \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetokb.com/api/external/v2/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetokb.com/api/external/v2/search"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"matches": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "https://spinkart.neetokb.com/articles/billing-and-invoices",
"title": "Billing and invoices",
"category": "Getting Started",
"category_url": "https://spinkart.neetokb.com/folders/getting-started",
"matched_title": "<span class=article-matched-tag>Billing</span> and invoices",
"matched_content": "Your <span class=article-matched-tag>billing</span> cycle starts on the day you subscribe.",
"matched_category": null
}
],
"pagination": {
"total_records": 123,
"total_pages": 123,
"current_page_number": 123,
"page_size": 123
}
}{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Query Parameters
The text to search for. Matching is performed from the start of each word.
"billing"
Page of results to retrieve, starting from 1. Defaults to 1 when omitted.
Number of results per page. Defaults to 30 when omitted.
Response
OK - Request succeeded
Hide child attributes
Hide child attributes
"https://spinkart.neetokb.com/articles/billing-and-invoices"
"Billing and invoices"
"Getting Started"
"https://spinkart.neetokb.com/folders/getting-started"
The article's title with the matched term wrapped in <span class=article-matched-tag>. Null when the term did not match the title.
"<span class=article-matched-tag>Billing</span> and invoices"
A fragment of the article's content with the matched term wrapped in <span class=article-matched-tag>. Null when the term did not match the content.
"Your <span class=article-matched-tag>billing</span> cycle starts on the day you subscribe."
The category name with the matched term wrapped in <span class=article-matched-tag>. Null when the term did not match the category.
null