GunSpec

Content

Public, key-free reads for GunSpec editorial content: blog posts and the product changelog. Both return only published entries and support pagination and category filtering. Use them to embed news, release notes, or articles directly in your own app.

Auth RequiredExplorer+

Returns every guide the documentation renders, with the headings each is divided into. Use it to see what is documented before searching, or to find the id and anchor of a section to read. The text is the page's own, so a guide cannot say something here that it does not say to a reader.

GET/v1/docs/guides

  • stringheaderrequired

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

  • object

    The response payload.

  • integer

    How many guides there are.

  • object[]

    Every guide, in the order the documentation lists them.

  • string

    The guide's id, passed to the read endpoint.

  • string

    The page's title.

  • string

    The page a reader would open.

  • string

    The opening prose: what the page is about.

  • integer

    The whole page in Markdown, so a caller can tell what reading it costs.

  • object[]

    Every heading on the page, in order.

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

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.