Skip to main content
POST
Search documents

Authorizations

Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Body

application/json

Schema for document search requests that don't need chat context

query
string
required
search_query_operator
string
required
knowledge_asset_ids
string[]
required
use_case_id
string
required
locale
enum<string>
default:en

Official locale abbreviations (ISO 639-1). Used for locale, prompting, DISA.

Available options:
bg,
cs,
da,
de,
el,
en,
es,
et,
fi,
fr,
hr,
hu,
is,
it,
ja,
ko,
lt,
lv,
nb,
nl,
pl,
pt,
ro,
ru,
sk,
sl,
sr,
sv,
tr,
zh
num_results
integer
default:5
enable_splitting_in_search_pipeline
boolean | null
enable_reformulation_in_search_pipeline
boolean | null
evaluation_prompts
EvaluationPrompt · object[] | null

Response

Successful Response

Response schema for document search endpoint.

documents
DocumentSearchResult · object[]
required
metadata
SearchDocumentsMetadata · object
required

Metadata schema for search documents response.