Skip to main content
POST
Search technical knowledge

Authorizations

Authorization
string
header
required

Mintlify Index API key with the mint_us_ prefix.

Body

application/json
query
string
required

Search query.

Minimum string length: 1
numResults
integer
required

Maximum number of results to return.

Required range: 1 <= x <= 20
text
default:false

Controls result content. Set to true to include matched content, false to omit it, or provide maxCharacters to include truncated content. When omitted, defaults to false.

includeDomains
string[]

Domains to include in search results.

Minimum array length: 1
Minimum string length: 1
excludeDomains
string[]

Domains to exclude from search results.

Minimum array length: 1
Minimum string length: 1

Response

Search completed successfully.

requestId
string
required

Unique identifier for the request.

results
object[]
required

Ranked search results.