跳到主要内容

OpenAPI Specification

The full OpenAPI 3.1 specification for the Anvil API is available as a static file:

Download

  • [anvil-openapi.yaml](/anvil-openapi.yaml) — full spec, validates against any OpenAPI 3.1 validator.
  • [anvil-postman.json](/anvil-postman.json) — Postman 2.1.0 collection with example payloads for every endpoint.
  • Versioning

    The spec covers v1 of the API. v2 is scaffolded but returns 501 NOT_IMPLEMENTED — see the gateway's /api/v2 paths once we begin shipping concrete v2 handlers.

    Postman

    Import the JSON file directly into Postman. Set the collection variables (baseUrl, apiKey, bearerToken) and you're ready to fire requests.