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.
查询参数
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
响应载荷
queryThe search query that produced these results.
localeThe documentation locale the results were drawn from.
resultsMatching documentation sections, ordered by descending relevance.
显示子属性
results.titleTitle of the documentation page this result belongs to.
results.sectionHeading of the matching section within the page.
results.slugStable identifier of the page. Pass it as the slug parameter of GET /v1/docs/pages to read the whole page as Markdown.
results.urlAbsolute URL of the matching section, including the heading anchor.
results.doc_urlAbsolute URL of the page, without the section anchor. Results from the same page share it, so it can be used to group them.
results.markdown_urlAbsolute URL that returns the page's full content as Markdown; also the page's canonical source URL.
results.snippetShort excerpt of the matching content, with the query terms in context. Always returned.
results.highlightsThe passages of the section that match the query, longer than the snippet. Returned only when contents is highlights.
results.token_estimateApproximate token count of the full page returned by markdown_url, to budget reading it. Results from the same page share it.
results.scoreRelevance score. Higher is more relevant; results are ordered by descending score.