API reference
Every published contract, every operation.
Schema-first: OpenAPI, SDKs, validators, docs and conformance tests are derived from schemas. Pick a contract to see its operations, parameters, request bodies and responses.
Contracts16 OpenAPI 3.1 contracts, 568 operations, rendered from KYE-Protocol/open-api as published. Request and response bodies reference the JSON Schemas published at KYE-Protocol/schemas. The index is also JSON
KYE Protocol™ Admin Root Endpoints
Root-level (non-/api/v1) endpoints on admin.kyeprotocol.com. These are NOT Clerk-session endpoints: /email-action is authenticated by a signed single-use email-action to…
admin-root.yaml 188 operations · v1.0.0KYE Protocol™ Admin API
Owner-only REST surface for admin.kyeprotocol.com. All endpoints require a Clerk JWT with role=owner. Operates against Cloudflare D1 (KYE_DB binding).
admin.yaml 18 operations · v1.0.0KYE Protocol™ Cloud Partner-Plane API
Consultant / partner / trainer / auditor plane of the KYE™ Cloud™ dashboard — app.kyeprotocol.com/partner/ (Cloudflare Pages Functions backed by the kye-prod D1 database;…
app-partner.yaml 3 operations · v1.0.0KYE Protocol™ App API — root paths
Companion document to app.yaml (whose server base is https://app.kyeprotocol.com/api/v1) for app-surface Pages-Functions endpoints that live OUTSIDE the /api/v1 base pat…
app-root.yaml 132 operations · v1.0.0KYE Protocol™ App API
Clerk-gated customer app surface for app.kyeprotocol.com. All endpoints require a Clerk JWT. Responses are automatically scoped to the caller's tenant derived from the J…
app.yaml 37 operations · v1.0.0KYE Protocol™ — Consultant Program™ API
Admin authoring (owner-gated), tenant-scoped read endpoints, and the public lead-capture endpoint for the KYE™ Consultant Program™.
consultant-programme.openapi.yaml 46 operations · v3.0.0KYE Protocol™ Core API — v3 Entity Hierarchy + Relationships
CRUD endpoints for the v3 KYE™ entity hierarchy (Tenant → Workspace → Principal, Team, Project, Resource, Policy, Legal Entity, Billing Account, Domain, Model, Tool, Exte…
core.openapi.yaml 7 operations · v1.0.0KYE™ Data Governance Pack™ API
Public API for the KYE™ Data Governance Pack™ (constitution §31). Customers register `kye.data_use_manifest.v1` and `kye.data_asset.v1` records via these endpoints; the r…
data-governance.openapi.yaml 12 operations · v1.0.0KYE Protocol™ — Native Engines API
Public REST surface for the four named sub-engines:
native-engines.openapi.yaml 25 operations · v1.0.0KYE Protocol™ — Reality Coupling™ API
Admin authoring (owner-gated) and tenant-scoped read endpoints for the KYE™ Reality Coupling™ surface — reality anchors, snapshots, runtime coupling checks, and stable-dr…
reality-coupling.openapi.yaml 1 operations · v1.0.0KYE Protocol™ Sandbox API
Public sandbox surface for sandbox.kyeprotocol.com (Cloudflare Pages Functions). No authentication — this is the try-before-signup playground. Every endpoint is a THIN d…
sandbox.yaml 56 operations · v1.0.0KYE Protocol™ — Scenario Testing™ + Approval Brief™ API
Admin authoring (owner-gated) and tenant-scoped read endpoints for the KYE™ Scenario Testing™ + Approval Brief™ surface.
scenario-testing.openapi.yaml 23 operations · v1.0.0KYE Protocol™ Site API
Public-site Pages Functions surface for kyeprotocol.com — the lead-capture forms (Audit Pilot™, PoC, GovernedUI access, contact), DSAR intake, expert-review wall, the Co…
site.yaml 2 operations · v3.0.0KYE Protocol™ State Library API
Browse and adopt entries from the KYE™ State Library — a curated catalogue of 30+ regulatory-aligned state machine templates covering banking, payments, insurance, health…
state-library.openapi.yaml 8 operations · v3.0.0KYE Protocol™ State API — State Machines + Events + Registry
Endpoints for creating and managing declarative state machines, firing state transition events, querying the State Registry, and listing state transitions.
state.openapi.yaml 7 operations · v1.0.0KYE Protocol™ Status API
Public status surface for status.kyeprotocol.com (Cloudflare Pages Functions). No authentication — this is the status page everyone checks when something is down. Per co…
status.yaml- DictionariesDictionaries are versioned lists of canonical terms — definitions, categories, severities, control mappings
- ManifestsEvery installable / verifiable / billable unit in KYE™ is a signed manifest. Connectors, widgets, SKUs, rule packs, sector packs, MCP tools, proof bundles…
- SchemasKYE™ schemas — JSON Schema 2020-12 contracts that validate every payload at runtime. Step 4 of the canonical 8-step KYE™ stack
- VocabularyCanonical KYE Protocol™ vocabulary: entity types, action types, decision codes, reason codes, capability kinds, side-effect levels, data classes, signal…
- Event-driven by constitutionKYE™ is the only AI-governance protocol that proves it isn't post-facto. Every privileged action emits a signed evidence envelope at the moment of the…
- Consultant Program™ APIKYE Protocol™ — Consultant Program™ API: 37 operations from consultant-programme.openapi.yaml, a published KYE Protocol™ OpenAPI contract.
- Example payloadsIllustrative JSON payloads that show the shape of KYE™ artefacts using public vocabulary: an entity, a delegation, a scope, a policy decision and a runtime…
- KYE Protocol™ Admin APIKYE Protocol™ Admin API: 188 operations from admin.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ Admin Root EndpointsKYE Protocol™ Admin Root Endpoints: 3 operations from admin-root.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ App APIKYE Protocol™ App API: 132 operations from app.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ App API (API reference)KYE Protocol™ App API — root paths: 3 operations from app-root.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ Cloud Partner-Plane APIKYE Protocol™ Cloud Partner-Plane API: 18 operations from app-partner.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ Core APIKYE Protocol™ Core API — v3 Entity Hierarchy + Relationships: 46 operations from core.openapi.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ Sandbox APIKYE Protocol™ Sandbox API: 1 operations from sandbox.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ Site APIKYE Protocol™ Site API: 23 operations from site.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ State APIKYE Protocol™ State API — State Machines + Events + Registry: 8 operations from state.openapi.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ State Library APIKYE Protocol™ State Library API: 2 operations from state-library.openapi.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE Protocol™ Status APIKYE Protocol™ Status API: 7 operations from status.yaml, a published KYE Protocol™ OpenAPI contract.
- KYE™ Data Governance Pack™ APIKYE™ Data Governance Pack™ API: 7 operations from data-governance.openapi.yaml, a published KYE Protocol™ OpenAPI contract.
- Native Engines APIKYE Protocol™ — Native Engines API: 12 operations from native-engines.openapi.yaml, a published KYE Protocol™ OpenAPI contract.
- Reality Coupling™ APIKYE Protocol™ — Reality Coupling™ API: 25 operations from reality-coupling.openapi.yaml, a published KYE Protocol™ OpenAPI contract.
- Scenario Testing™ + Approval Brief™ APIKYE Protocol™ — Scenario Testing™ + Approval Brief™ API: 56 operations from scenario-testing.openapi.yaml, a published KYE Protocol™ OpenAPI contract.