Get a documentation page
GET
/v1/docs/pages
bird docs readcurl -X GET "https://us1.platform.bird.com/v1/docs/pages" \
-H "Authorization: Bearer $TOKEN"Returns the full Markdown content of a documentation page. Get its slug from GET /v1/docs/search, or pass index for the documentation landing page.
No authentication is required. An unknown slug returns 404, and 503 means the documentation backend is temporarily unavailable.
Paramètres de requête
slug
string
Slug of the page to read, as returned in the slug field of a search result (for example guides/email/contacts). Use index for the documentation landing page.
locale
string
Documentation locale to read, as a language-region code such as en-us. Defaults to en-us when omitted or unavailable.
Contenu de la réponse
slug
string
obligatoire
Slug of the page, echoing the requested slug.
locale
string
obligatoire
Documentation locale the page was drawn from.
url
string
obligatoire
Absolute URL of the page, suitable to cite as the source of an answer.
markdown
string
obligatoire
The page's full content as Markdown.