kb
Keyword + vector search over the KB.
Keyword + vector search over the KB.
OpenAPI specificationPOST
/api/v1/kb/searchAuthentication
bearerAuth
Request
curl --globoff --request POST \
--url 'https://honen.com/api/v1/kb/search' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "<query>"
}'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.
Request body schema or example
{
"type": "object",
"properties": {
"query": {
"type": "string"
},
"limit": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
}
},
"required": [
"query"
]
}Responses
200Command result.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"data": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"excerpt": {
"type": "string",
"nullable": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FOLDER",
"DOCUMENT"
]
},
"parentId": {
"type": "string",
"nullable": true
},
"depth": {
"type": "number"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"latestVersionId": {
"type": "string",
"nullable": true
},
"isDeleted": {
"type": "boolean",
"enum": [
false,
true
]
},
"role": {
"type": "string",
"enum": [
"ADMIN",
"VIEWER",
"EDITOR",
"MAINTAINER"
]
},
"url": {
"type": "string"
},
"href": {
"type": "string"
},
"dashboardUrl": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"syncProvider": {
"type": "string",
"enum": [
"GOOGLE_DRIVE",
"GRANOLA",
"WEB",
"YOUTUBE",
"NOTION",
"CONFLUENCE",
"SALESFORCE",
"DOCUMENT360",
"ONEDRIVE",
"SHAREPOINT",
"GITHUB"
],
"nullable": true
},
"syncStatus": {
"type": "string",
"enum": [
"SYNCING",
"SYNCED",
"ERROR"
],
"nullable": true
},
"syncExternalUrl": {
"type": "string",
"nullable": true
},
"syncedAt": {
"type": "string",
"nullable": true
},
"syncErrorMessage": {
"type": "string",
"nullable": true
},
"syncContentMode": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"enum": [
"course"
],
"nullable": true
},
"sourcePath": {
"type": "string",
"nullable": true
},
"readOnly": {
"type": "boolean",
"enum": [
false,
true
]
}
},
"required": [
"excerpt",
"id",
"title",
"type",
"parentId",
"depth",
"tags",
"latestVersionId",
"isDeleted",
"role",
"url",
"href",
"dashboardUrl",
"updatedAt",
"syncProvider",
"syncStatus",
"syncExternalUrl",
"syncedAt",
"syncErrorMessage",
"syncContentMode",
"source",
"sourcePath",
"readOnly"
]
}
},
"degraded": {
"type": "boolean",
"enum": [
false,
true
]
},
"failedPasses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"snapshot",
"items",
"vectors"
]
}
}
},
"required": [
"results",
"degraded",
"failedPasses"
]
}
},
"required": [
"success",
"data"
]
}400Malformed JSON request body.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}401Missing or invalid Connector credentials.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}403Connector policy does not permit this command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}404Unknown command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}422Input validation error.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}