API reference

KYE Protocol™ State Library API

2 operations · state-library.openapi.yaml

KYE Protocol™ State Library API: try the first operations

Demo data

You learn: What a call to this API sends and gets back. You can: Send a request.

API client · List published State Library entries

Request
GET /api/v1/state-library
Response 200
{
  "data": [
    {
      "applies_to_entity_class": "<applies_to_entity_class>",
      "authors": [
        {
          "name": "<name>",
          "org": "<org>",
          "role": "<role>"
        }
      ],
      "category": "banking",
      "compatibility": [
        "<compatibility>"
      ],
      "deprecated_at": "2026-10-01T09:00:00Z",
      "description": "<description>",
      "library_id": "<library_id>",
      "license": "MIT",
      "machine_seal": "<machine_seal>",
      "platform_locked_obligations": [
        {
          "id": "<id>",
          "regulatory_basis": "<regulatory_basis>",
          "summary": "<summary>"
        }
      ],
      "published_at": "2026-10-01T09:00:00Z",
      "regulatory_alignment": [
        "<regulatory_alignment>"
      ],
      "schema_version": "kye.state.library_entry.v1",
      "signature": {
        "alg": "EdDSA",
        "kid": "<kid>",
        "value_b64": "<value_b64>"
      },
      "states": [
        {
          "description": "<description>",
          "kind": "initial",
          "name": "<name>",
          "obligations": [
            {
              "evidence_class": null,
              "frequency": null,
              "id": null,
              "sla_hours": null,
              "summary": null
            }
          ],
          "sla_max_dwell_hours": 0
        }
      ],
      "supersedes": "<supersedes>",
      "title": "<title>",
      "transitions": [
        {
          "actor_role_required": "<actor_role_required>",
          "effects": [
            "<effects>"
          ],
          "evidence_class": "<evidence_class>",
          "from": "<from>",
          "guards": [
            "<guards>"
          ],
          "max_dwell_time_hours": 0,
          "to": "<to>"
        }
      ],
      "version": "<version>"
    }
  ]
}
How this widget is built
Demonstrates
KYE™ API
Components
  • The OpenAPI 3.1 contract
  • Request and response examples from the contract
Flow
Request → response, from the published contract. Architecture diagram
Used on
Servers
https://api.kyeprotocol.com
Version
3.0.0
Source
state-library.openapi.yaml

Browse and adopt entries from the KYE™ State Library — a curated catalogue of 30+ regulatory-aligned state machine templates covering banking, payments, insurance, healthcare, pharma, logistics, energy, regtech, and AI governance.

state-library

GET/api/v1/state-libraryList published State Library entries

Auth: bearerAuth

Parameters

nameintypedescription
categoryquerystring
entity_classquerystring
regulatory_alignmentquerystring

Responses

  • 200 Catalogue of library entries
GET/api/v1/state-library/{library_id}Get full detail for a State Library entry

Auth: bearerAuth

Parameters

nameintypedescription
library_id requiredpathstring

Responses

  • 200 Library entry
  • 404 Not found