---
title: "API reference | KYE Protocol™"
description: "The KYE Protocol™ API reference: 16 OpenAPI 3.1 contracts and 568 operations (runtime, core, app, admin, sandbox, status, state, scenario testing and more), rendered from KYE-Protocol/open-api."
url: https://kyeprotocol.com/developers/api/
lang: en
source: "KYE Protocol"
---

> The KYE Protocol™ API reference: 16 OpenAPI 3.1 contracts and 568 operations (runtime, core, app, admin, sandbox, status, state, scenario testing and more), rendered from KYE-Protocol/open-api.

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.

**Contracts** 16 OpenAPI 3.1 contracts, 568 operations, rendered from [KYE-Protocol/open-api](https://github.com/KYE-Protocol/open-api) as published. Request and response bodies reference the JSON Schemas published at [KYE-Protocol/schemas](https://github.com/KYE-Protocol/schemas). The index is also [JSON](https://kyeprotocol.com/developers/api/index.json)

[3 operations · v1.0.0 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](https://kyeprotocol.com/developers/api/admin-root/) [188 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/admin/) [18 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/app-partner/) [3 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/app-root/) [132 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/app/) [37 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/consultant-programme/) [46 operations · v3.0.0 KYE 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](https://kyeprotocol.com/developers/api/core/) [7 operations · v1.0.0 KYE™ 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](https://kyeprotocol.com/developers/api/data-governance/) [12 operations · v1.0.0 KYE Protocol™ — Native Engines API Public REST surface for the four named sub-engines: native-engines.openapi.yaml](https://kyeprotocol.com/developers/api/native-engines/) [25 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/reality-coupling/) [1 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/sandbox/) [56 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/scenario-testing/) [23 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/site/) [2 operations · v3.0.0 KYE 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](https://kyeprotocol.com/developers/api/state-library/) [8 operations · v3.0.0 KYE 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](https://kyeprotocol.com/developers/api/state/) [7 operations · v1.0.0 KYE 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](https://kyeprotocol.com/developers/api/status/)
