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" \
--url-query "contents=snippet"Searches the Bird documentation and returns the most relevant sections for a query, best match first. Each result links to its section heading and carries the page's slug; read the whole page with GET /v1/docs/pages when a snippet is not enough.
No authentication is required. A blank query returns 400, and 503 means search is temporarily unavailable.
Paramètres de requête
q
string
The text to search the documentation for. Must not be blank.
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).
contents
string
How 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.
Contenu de la réponse
query
string
obligatoire
The search query that produced these results.
locale
string
obligatoire
The documentation locale the results were drawn from.
results
array of object
obligatoire
Matching documentation sections, ordered by descending relevance.
Afficher les attributs enfants
results.title
string
obligatoire
Title of the documentation page this result belongs to.
results.section
string
obligatoire
Heading of the matching section within the page.
results.slug
string
obligatoire
Stable identifier of the page. Pass it as the slug parameter of GET /v1/docs/pages to read the whole page as Markdown.
results.url
string
obligatoire
Absolute URL of the matching section, including the heading anchor.
results.doc_url
string
obligatoire
Absolute 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_url
string
obligatoire
Absolute URL that returns the page's full content as Markdown; also the page's canonical source URL.
results.snippet
string
Short excerpt of the matching content, with the query terms in context. Always returned.
results.highlights
array of string
The passages of the section that match the query, longer than the snippet. Returned only when contents is highlights.
results.token_estimate
integer
obligatoire
Approximate token count of the full page returned by markdown_url, to budget reading it. Results from the same page share it.
results.score
number
obligatoire
Relevance score. Higher is more relevant; results are ordered by descending score.