Read 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 single Bird documentation page, identified by its slug. Get the slug from a search result (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.
Query Parameters
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.
Response Payload
slug
string
required
Slug of the page, echoing the requested slug.
locale
string
required
Documentation locale the page was drawn from.
url
string
required
Absolute URL of the page, suitable to cite as the source of an answer.
markdown
string
required
The page's full content as Markdown.