Content

Latest example verification runs

The receipts behind the "verified" badges in the documentation, for every surface. The SDK surface installs the published package into a fresh project and runs each sample exactly as printed; the API surface runs the cURL command exactly as the reference prints it, with the key substituted at run time; the MCP surface calls every tool on the hosted MCP server with its documented example arguments. This returns the most recent run for each surface and language, with the outcome of every example. Examples that would write are never run against production, since each would create a real ticket, webhook endpoint or seller offer, and are reported as skipped with that reason, so the counts never imply coverage the run does not have.

No API key required.

get/v1/examples/verification

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/examples/verification
  • Auth: one of:
    • none
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

surface'sdk' | 'api' | 'mcp'

Narrow to one surface: sdk for the SDK references, api for the reference samples, mcp for the hosted MCP server's tools. Omitted returns every surface.

include'samples'

samples adds sample to each example: what it answered when the run executed it, trimmed for display. Only the MCP surface stores answers today; every example says whether it has one in hasSample either way.

Response

Latest example verification runs

successboolean required

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

Example response

{
  "success": true,
  "data": {
    "runs": [
      {
        "surface": "api",
        "language": "typescript",
        "checkKind": "executed",
        "sdkVersion": "0.2.3",
        "apiHost": "https://api.gunspec.io",
        "ranAt": "2026-09-13T03:15:00.000Z",
        "commitSha": "9f1c2ab",
        "runUrl": "https://github.com/buun-group/gunspec/actions/runs/123456",
        "passed": 118,
        "skipped": 13,
        "unsupported": 11,
        "examples": [
          {
            "exampleId": "sdk-firearms-list",
            "resource": "firearms",
            "method": "list",
            "endpoint": "GET /v1/firearms",
            "status": "passed",
            "durationMs": 412,
            "hasSample": true,
            "sample": {
              "id": "glock-g17",
              "name": "Glock 17"
            }
          }
        ]
      }
    ]
  }
}

Changes

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