Skip to main content
GET
Search the builder knowledge base

Authorizations

X-API-KEY
string
header
required

Query Parameters

query
string
required

Search text, matched against document titles, tags and bodies

Minimum string length: 1
top
integer
default:10

Maximum number of results to return

Required range: x >= 1
category
string

Only return documents in this knowledge category; GET /v1/builder-knowledge/categories lists the valid values

Response

Successful response

Ranked builder knowledge search results.

results
SearchResultItem · object[]
required

Ranked search results

total
integer
required

Number of results returned

query
string
required

The original search query

Last modified on November 12, 2026