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.

Optional AuthExplorer+

Every example on the SDK reference is executed against this API on a schedule and after each SDK release: the published package, a fresh project, the snippet exactly as printed. This returns the most recent run for each language, with the outcome of each example. Write examples are never run against production, since they 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.

GET/v1/sdk/verification

  • stringheader

    Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields. Authorization: Bearer <key> is accepted in its place.

  • object

    The response payload.

  • SdkVerificationRun[]

    The latest run per language, ordered by language.

  • string

    Which promise the run is about: sdk for the published packages, api for the cURL commands the reference prints.

  • string

    The sample's own language. On an SDK run, typescript or python for the published package. On an API run, the tab of the reference it came from: curl, javascript (the TypeScript tab's generated fetch), python (its generated requests), or unity, unreal and godot, which are checked rather than executed.

  • string

    How the run arrived at its results. executed ran the sample against this API. static could not, and checked the sample against the operation it documents instead: the Unity, Unreal and GDScript samples are fragments meant for a class, an actor or a scene, so running one would mean wrapping it in code the reference does not print.

  • string

    What was exercised: the release installed from the registry on an SDK run, and the spec version the samples were generated from on an API run. The release rather than the version in our tree, because the badge vouches for what a reader gets today.

  • string

    The API the run was executed against. Production, so the badge vouches for the live service rather than a preview.

  • string

    When the run finished, ISO 8601.

  • string | null

    The commit of this repository the run was started from, or null where CI did not report one.

  • string | null

    The CI run, so the claim can be checked rather than taken.

  • integer

    Examples that ran and returned what the page prints.

  • integer

    Examples that ran and did not. A non-zero count is what takes the badge down.

  • integer

    Write examples, which are never run against production: each would create a real ticket, webhook endpoint or seller offer.

  • integer

    Examples this SDK has no method for. The reference shows no sample for them either.

  • 400VALIDATION_ERRORValidation error
  • 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.