Guild API

OpenAPI spec

The entire Zyron API — replay parser, all guild endpoints, and the webhook events — is published as an OpenAPI 3.1 document you can feed to codegen tools.

Download

The spec is served at a stable URL and regenerated with each release:

text

https://api.zyron.pro/openapi.json

bash

curl https://api.zyron.pro/openapi.json -o zyron-openapi.json

Single source of truth

Every endpoint on the reference pages is described in the spec — request bodies, response schemas, error codes, the Idempotency-Key header, and the outbound webhook events (under the OpenAPI webhooks field).

Generate a client

Point any OpenAPI-aware generator at the URL to get a typed client in your language — no hand-written HTTP glue:

# TypeScript types straight from the spec
npx openapi-typescript https://api.zyron.pro/openapi.json -o zyron-api.d.ts

Authenticate generated clients with your API key as a bearer token, exactly as the reference examples show.

Coverage

The document covers the unauthenticated /health probe, the Replay Parser, and the complete Guild API surface under /guilds/:guildId. Security schemes cover both Authorization: Bearer and X-API-Key. The prose reference pages stay the friendly front door; the spec is the exact contract.