API Reference

Interactive OpenAPI 3.1 reference for the Arkanis public REST surface. The complete spec, hosted by Redocly, reading directly from the canonical api.arkanis.gg endpoint.

What is this?

The machine-readable OpenAPI 3.1 spec for every public REST endpoint, served live fromapi.arkanis.gg/openapi.yamland browsable through the Redocly-hosted viewer. Generated from the same Fastify routes that serve production traffic, so it never drifts.

Why you might want it

Drop the raw YAML into Swagger UI, Stoplight, an IDE plugin, or a code generator to produce typed clients in any language. Use the interactive viewer when you just want to browse endpoints and copy a curl example.

OpenAPI 3.1 Specification

The complete OpenAPI 3.1 specification for the public REST surface. All endpoints under /api/public/v1/* are documented, including request bodies, response shapes, error envelopes, and the capability each route requires.

Direct browser calls to the API are blocked by CORS (spec §5.4). Copy the curl examples from the reference and run them from a terminal, server, or scripting environment.

Open the Reference

Use the interactive viewer for browsing endpoints, expanding schemas, and copying request examples. Use the raw download to plug the spec into Swagger UI, Stoplight, or an IDE OpenAPI plugin.

Open interactive referenceDownload openapi.yaml

The interactive viewer is hosted by Redocly and reads our spec from https://api.arkanis.gg/openapi.yaml. The raw YAML link is the same file. Drop it into your tool of choice (Swagger UI, Stoplight, IDE OpenAPI plugins) when you want offline browsing or schema generation.

What the Reference Covers

The reference documents the full v1 public surface:

  • Every endpoint under /api/public/v1/* with its method, path, and capability requirement.
  • Request body schemas, including the _confirmation sentinel format for destructive operations.
  • Response shapes for both the success and error envelopes, with the standard code / message / requestId fields.
  • Authentication scheme (Authorization: Bearer arkpat_...) and the rate-limit headers returned on every response.
ℹ️
Note
The OpenAPI spec is generated from the same Fastify route definitions that serve production traffic. If the reference says a field exists, it exists in the live API.

Related

Developer OverviewAuthenticationREST QuickstartRate Limits and Errors
Destructive Actions & Re-authSettings & Channels