Get documentation search results
/v1/docs/searchbird docs search <q>curl -X GET "https://us1.platform.bird.com/v1/docs/search" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=10" \
--url-query "contents=snippet"Searches the documentation and returns matching sections, best match first. Each result links to its section heading and includes the page's slug; read the full page with GET /v1/docs/pages.
No authentication is required. A blank query returns 400, and 503 means search is temporarily unavailable.
Query Parameters
qstringThe text to search the documentation for. Must not be blank.
localestringDocumentation locale to search, as a language-region code such as en-us. Defaults to en-us when omitted or unavailable.
limitintegerMaximum number of results to return (1–25).
contentsstringHow much of each matching section to return. snippet (the default) returns a short preview; highlights additionally returns the passages that match the query. For the full text, fetch a result's markdown_url.
Possible values: snippet, highlights
Response Payload
queryThe search query that produced these results.
localeThe documentation locale the results were drawn from.
resultsMatching documentation sections, ordered by descending relevance.
Related resources
Continue with the documentation, guides and examples for this topic.