Search content

Changed on Sep 17, 2026

Searches through indexed content using query.

Required scope: `knowledge:read`

post/search

Request

Base URL
https://developer.qaip.com/api/v1
URL
https://developer.qaip.com/api/v1/search
Auth
API key in header x-api-key

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

Sep 17, 20262489c6f1a9d8 Revision changes
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
Sep 11, 2026c4ae2348acf6 Revision changes
- info
  added the new contains enum value to the request property ///
- info
  added the new contains enum value to the request property ///
- info
  added the new contains enum value to the request property ///
- info
  added the new contains enum value to the request property ///
- info
  added the new integer_list enum value to the request property ///
- info
  added the new integer_list enum value to the request property ///
- info
  added the new integer_list enum value to the request property ///
- info
  added the new integer_list enum value to the request property ///
- info
  added the new string_list enum value to the request property ///
- info
  added the new string_list enum value to the request property ///
- info
  added the new string_list enum value to the request property ///
- info
  added the new string_list enum value to the request property ///

Operation history (19 revisions)