Sign in
Semantic Search

Perform semantic search

Run a semantic search across your organization's knowledge base. Matching is meaning-based, so relevant results surface even when the wording differs from the query.

Use optional filters to narrow the scope:

  • filters.apps — restrict to specific connector apps (for example Google Drive or Confluence).
  • filters.kb — restrict to specific knowledge bases.

The response returns a searchId for the persisted search along with ranked matches, each carrying a relevance score and the source document's metadata. Past searches can be retrieved via GET /search.

post/search

Request body

querystring required

Natural language search query. The system understands semantic meaning, not just keywords.

limitinteger

Maximum number of results to return

Example request

{
  "query": "employee onboarding procedures"
}

Response

Search ID plus retrieval payload (searchResponse) from the AI search service

searchIdstring objectId required

Changes

Changed in 1 of the 15 revisions of this API.6

  • 5798f431973a6See the full diff
    • ○

      added the optional property searchResponse/records/items/parsingStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property searchResponse/records/items/processingStartedAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property searchResponse/records/items/storageDocumentId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property searchResponse/virtual_to_record_map/additionalProperties/parsingStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property searchResponse/virtual_to_record_map/additionalProperties/processingStartedAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property searchResponse/virtual_to_record_map/additionalProperties/storageDocumentId to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog