GunSpec

Docs

Resource class for the documentation endpoints. Instantiated internally by the GunSpec client and exposed as client.docs.

Auth RequiredExplorer+

client.docs.searchGuides()

The sections of the guides that answer a question, best first. 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.

searchGuides(params: SearchDocsGuidesParams): Promise<APIResponse<DocsGuideSearch>>
GET/v1/docs/guides/search

Explorer+

  • stringheaderrequired

    Your API key. Authorization: Bearer <key> is accepted in its place.

  • stringrequired

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

    Max length
    200
    Example
  • integerdefault8

    How many sections to return.

    Range
    1 – 25
    Example

application/json

  • object

    The response payload.

  • string

    The question as it was asked.

  • integer

    How many sections matched, of which results carries the best.

  • object[]

    The matching sections, best first.

  • string

    The guide the section is on.

  • string

    That guide's title.

  • string

    The section's anchor.

  • string

    The heading.

  • string

    The heading with the ones above it.

  • string

    The page, opened at that heading.

  • string

    The opening of the section, so a caller can judge it without reading it.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Not yet in the Python SDK.

Full rate limits

Minimum tier
Explorer+
Monthly quota
200/mo
Rate limit
10/min
Daily cap
50

Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.