Skip to main content
POST
Semantic search across training and knowledge base

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string
required
Required string length: 2 - 500
limit
number
default:10
Required range: 1 <= x <= 50
visibility
enum<string>[]
Available options:
internal,
public
sourceTypes
enum<string>[]
Available options:
custom_training,
help_center,
integration,
website,
workflow
dataSources
enum<string>[]
Available options:
confluence,
notion,
zendesk_support,
shopify,
gitbook,
intercom,
front,
freshdesk,
hubspot_kb,
ai_instructions,
custom_training,
website,
workflow
sortBy
enum<string>
default:relevance
Available options:
relevance,
handoffs,
citations
dateFrom
any
dateTo
any
include_content
boolean
default:true

Include the full content field in results. Set to false to reduce response size.

Response

Default Response

results
object[]
required
total_count
number
required