v1

latestOpenAPI 3.0.12026-07-269427.8 KB

Search documentation

Perform semantic and keyword searches across your documentation with configurable filtering and pagination.

Authenticate with an assistant API key. Search requests do not consume credits.

post/v1/search/{domain}

Path parameters

domainstring required

The domain identifier from your domain.mintlify.site URL. Can be found at the end of your dashboard URL. For example, app.mintlify.com/organization/domain has a domain identifier of domain.

Request body

querystring required

The search query to execute against your documentation content.

pageSizeinteger

Number of search results to return. Must be between 1 and 50. Defaults to 10 if not specified.

scoreThresholdnumber

Minimum relevance score for results. Only results with a score at or above this threshold are returned. Must be between 0 and 1.

Response

Search results

contentstring

The matching content from your documentation.

pathstring

The path or URL to the source document.

metadataobject

Additional metadata about the search result.