Skip to main content
GET
Search the API catalog

Query Parameters

q
string

What you need, in your own words. Long queries are truncated before ranking.

category
string

Restrict the response to one category, using an entry's category.

platform
string

Restrict results to one platform, using a result's platformId.

limit
integer

Maximum results in this response. Omit it for the ranked default. A value above the server's maximum is reduced to it rather than rejected, and total still reports how many matched.

Required range: x >= 1

Response

Ranked matches.

ranking
enum<string>
required

Which ranker served this response.

Available options:
keyword,
semantic
results
object[]
required
total
integer
required

Matches found before limit was applied.