Skip to documentation

Search the public documentation API

Retrieve source-reviewed public docs through REST or MCP without querying customer feedback.

Updated Read as Markdown

Search setup and API guidance

Documentation search looks only at the public documentation bundled with this release. It does not search inbox feedback, private forms, organization data or customer answers.

bash
curl https://api.pollenate.dev/docs/search \
  -H "Content-Type: application/json" \
  --data '{ "query": "collect API authentication", "limit": 5 }'

This REST endpoint is public and does not require a Pollenate key or a paid plan.

Field Validation
query String, 2–200 characters after whitespace normalization; the raw input must also be at most 200 characters
limit Optional integer from 1 through 10; default 8

The JSON request body must not exceed 4 KiB.

Response contract

json
{
  "query": "collect API authentication",
  "mode": "lexical",
  "results": [
    {
      "id": "RESULT_ID",
      "pageSlug": "api/authentication",
      "title": "API authentication and credential types",
      "section": "API",
      "heading": "Endpoint compatibility",
      "href": "/docs/api/authentication/#endpoint-compatibility",
      "excerpt": "A bounded excerpt from the matching documentation.",
      "score": 1
    }
  ],
  "version": "DOCUMENTATION_VERSION",
  "baseUrl": "https://pollenate.dev"
}

This is an illustrative result. IDs, scores, excerpts and version values are generated from the current corpus. heading is optional. Resolve relative href values against the returned baseUrl; open the linked section for the full explanation. Excerpts are limited to 240 characters, so a result is context for finding a page, not a complete API specification. A plain Markdown mirror is available at /docs/PAGE_SLUG.md.

mode: "lexical" means the bundled text index answered the request. mode: "hybrid" combines eligible semantic results with lexical matches. Semantic documentation search is separately configured; when unavailable, stale, throttled or failing, the endpoint still returns lexical results with HTTP 200. Do not depend on hybrid mode always being enabled.

Use from an assistant

The MCP tool is search_docs, with the same query and limit arguments and result object. The existing MCP transport still requires authentication, but documentation lookup does not require a customer-feedback permission scope. No separate docs-fetch tool is provided; follow the returned public link.

For customer comments, use feedback search instead. Its credentials, limits and result model are different.

Errors and integration behavior

  • 400: invalid JSON, invalid query or a non-integer/out-of-range limit.
  • 413: body exceeds 4 KiB.
  • 429: public search rate limit (60 requests per minute per IP, enforced per service location); honor Retry-After: 60.

Debounce interactive search, cancel stale UI requests and show a useful empty state when no results match. Do not send secrets or customer text as documentation queries.