Search

Search

Perform fast keyword based search across your knowledge sources.

Use "Retrieval" instead to provide context for LLMs/agents with semantic search.

post/query/v1/projects/{project_id}/search/

Request

  • Base URL: https://api.kapa.ai
  • URL: https://api.kapa.ai/query/v1/projects/{project_id}/search/
  • Auth: one of:
    • API key in cookie sessionid
    • HTTP bearer
    • API key in header X-API-KEY

Path parameters

project_idstring required

The ID of the project.

Request body

source_group_ids_includestring[]

Optional list of source group IDs for filtering retrieval data.

source_ids_includestring[]

Optional list of source IDs for filtering retrieval data.

querystring required

The search query.

num_resultsinteger

The number of results to return.

include_source_namesstring[]

The source types to include in the search. This field is experimental and may be changed or removed in the future.

source_group_orderstring[]

The order of source names in which the results should be returned.

source_ids_orderstring[]

The order of source IDs in which the results should be returned.

Response

contentstring required

The content of the search result.

source_urlstring required

The URL of the source.

titlestring required

The title of the source.

source_typestring required

The type of the source.

Changes

No recorded changes to this operation across all 1 revision of this API.