Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

Get documentation search results

GET
/v1/docs/search
bird docs search <q>

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.

Parametry zapytania

qstring

The text to search the documentation for. Must not be blank.

localestring

Documentation locale to search, as a language-region code such as en-us. Defaults to en-us when omitted or unavailable.

limitinteger

Maximum number of results to return (1–25).

contentsstring

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.

Possible values: snippet, highlights

Treść odpowiedzi

query
string
wymagane

The search query that produced these results.

locale
string
wymagane

The documentation locale the results were drawn from.

results
array of object
wymagane

Matching documentation sections, ordered by descending relevance.

Pokaż atrybuty podrzędne
results.title
string
wymagane

Title of the documentation page this result belongs to.

results.section
string
wymagane

Heading of the matching section within the page.

results.slug
string
wymagane

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
wymagane

Absolute URL of the matching section, including the heading anchor.

results.doc_url
string
wymagane

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
wymagane

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
wymagane

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
wymagane

Relevance score. Higher is more relevant; results are ordered by descending score.

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy