Search documentation
GET
/v1/docs/search
curl -X GET "https://us1.platform.bird.com/v1/docs/search" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=10"Search the Bird documentation and return the most relevant sections for a query. Each result links to the matching section heading.
Query Parameters
q
string
The text to search for.
locale
string
Documentation locale to search, as a language-region code such as en-us. Defaults to en-us when omitted or unavailable.
limit
integer
Maximum number of results to return (1–25).
Response Payload
query
string
required
The search query that produced these results.
locale
string
required
The documentation locale the results were drawn from.
results
array of object
required
Matching documentation sections, ordered by descending relevance.
Show child attributes
results.title
string
required
Title of the documentation page this result belongs to.
results.section
string
required
Heading of the matching section within the page.
results.url
string
required
Relative path to the matching section, including the heading anchor.
results.snippet
string
Short excerpt of the matching content, with the query terms in context.
results.score
number
required
Relevance score. Higher is more relevant; results are ordered by descending score.