Sign in
search

Search content

Searches through indexed content using query.

Required scope: `knowledge:read`

post/search

Request body

querystring required

Search query string

tagsstring[]

target tag names to be obtained

tag_idsstring[]

target tag IDs to be obtained

tag_filter_logic'AND' | 'OR'

Logical operator for combining filter conditions

source_group_idstring uuid

Source group ID to search within. For crawl data, specify the crawl_id returned by the crawl API.

source_typesSourceType[]
file_typesFileType[]
date_frominteger

Start date for content search (Unix timestamp in seconds)

date_tointeger

End date for content search (Unix timestamp in seconds)

domainsstring[]

Array of domains to search within (supports partial matching)

limitinteger

Maximum number of results to return

offsetinteger

Number of results to skip

use_postfilterboolean

Whether to bypass LanceDB prefilter and apply WHERE after the vector search (IVF_PQ) returns top-K. Significantly faster for broad filters that cover most of the table, but may return fewer than limit results when the hit rate is low.

authz_policystring

(reserved for future use) Name of the registered authz policy to evaluate for this request. Defaults to the reserved "default" policy when omitted. Ignored when authz is disabled. An unknown or malformed name returns 400.

principal_idstring

Identifier of the end-user (principal) on whose behalf this request is made. Used to look up the principal's authz subject attributes for policy evaluation. When omitted, subject attributes are empty (most restrictive). Ignored when authz is disabled.

Example request

{
  "query": "machine learning and artificial intelligence",
  "date_from": 1735639200,
  "date_to": 1735639200,
  "domains": [
    "example.com",
    "blog.example.com"
  ],
  "limit": 10,
  "authz_policy": "external-chatbot",
  "principal_id": "user-123"
}

Response

Successful search results

createdinteger required

The Unix timestamp (in seconds) of when the search was performed

Example response

{
  "created": 1677649420
}

Changes

Changed in 16 of the 76 revisions of this API.103063

  • c4ae2348acf612See the full diff
    • ○

      added the new contains enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new contains enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new contains enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new contains enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new integer_list enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new integer_list enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new integer_list enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new integer_list enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new string_list enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new string_list enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new string_list enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new string_list enum value to the request property ///

      request-property-enum-value-added

  • 0375753f8ee31See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • dda59d58227c1See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 05add33422b23See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • 02104c44c0991See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 995a53b75a921See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 756b9db552592See the full diff
    • ○

      added the new datetime enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new datetime enum value to the request property ///

      request-property-enum-value-added

  • 288bf03b951a1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 82b3e15cf9471See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 13aa0e48bae91See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

Of the 76 revisions, 20 have no diff computed.