Content

Search the documentation guides

Returns the sections of the guides that answer a question, best first, each with a snippet and a link to the heading it came from. This is the entry point: search, then read the one section you need rather than a whole page. A question the guides do not cover returns no results rather than the nearest paragraph.

Available on every plan. Requires an API key; Explorer keys receive a reduced field set.

get/v1/docs/guides/search

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/docs/guides/search
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

qstring required

The question, in the words it would be asked in.

limitinteger

How many sections to return.

Response

Search the documentation guides

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "query": "how do I handle a 429",
    "total": 34,
    "results": [
      {
        "guideId": "rate-limits",
        "guideTitle": "Rate Limits & Plans",
        "anchor": "rate-limits-retry",
        "title": "What to do when you are limited",
        "trail": "What to do when you are limited",
        "url": "https://docs.gunspec.io/en/rate-limits#rate-limits-retry",
        "snippet": "A 429 carries Retry-After in seconds."
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.