Error
A valid request URL is required to generate request examples{
"query": "<string>",
"results": [
{
"slug": "<string>",
"title": "<string>",
"snippet": "<string>",
"collection": {
"slug": "<string>",
"name": "<string>"
}
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Help center
Search the help center
Full-text search over the published versions only — unpublishing removes an article’s hits by the same pointer move that removes its page. The query is whatever a person typed into a box: quotes and stray syntax narrow the search, they never error it, and an empty or unmatched query answers an empty list.
Each hit carries a snippet with the matched words wrapped in <b>…</b> — the one place this surface produces HTML, and only these tags.
Same caching as the index: a cache keys on the full URL, so each distinct q is its own entry. Rate limited to 240 requests per minute per IP.
GET
/
v1
/
help
/
{publishableKey}
/
search
Error
A valid request URL is required to generate request examples{
"query": "<string>",
"results": [
{
"slug": "<string>",
"title": "<string>",
"snippet": "<string>",
"collection": {
"slug": "<string>",
"name": "<string>"
}
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}