API reference

KYE Protocol™ Sandbox API

1 operations · sandbox.yaml

KYE Protocol™ Sandbox 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 · Demo three-outcome authority decision (public playground)

Request
POST /api/v1/pdp/decide

{
  "action": "<action>",
  "context": {},
  "purpose": "<purpose>",
  "subject": "<subject>"
}
Response 200
{
  "decided_at": "2026-10-01T09:00:00Z",
  "decision": "allow",
  "decision_id": "<decision_id>",
  "demo": true,
  "evidence": {
    "id": "<id>",
    "kind": "audit_reference",
    "outcome": "<outcome>",
    "reason": "<reason>",
    "verify_url": "https://example.org/"
  },
  "evidence_pack": {},
  "note": "<note>",
  "ok": true,
  "reason_code": "<reason_code>",
  "replay_seed": "<replay_seed>"
}
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://sandbox.kyeprotocol.com
Version
1.0.0
Source
sandbox.yaml

Public sandbox surface for sandbox.kyeprotocol.com (Cloudflare Pages Functions). No authentication — this is the try-before-signup playground. Every endpoint is a THIN demo adapter over the ONE canonical engine behind the authenticated production surface (§0: zero sandbox-local decision logic), runs against a fixed demo tenant (kye:tenant:sandbox-demo), persists nothing, and marks every response demo: true. The production Authority API is POST https://app.kyeprotocol.com/api/v1/runtime/evaluate (app-post-runtime-evaluate — the app-surface projection of the Core wire-contract op evaluateRuntime).

Playground

POST/api/v1/pdp/decideDemo three-outcome authority decision (public playground)

Evaluates one agent action through the SAME deterministic three-outcome decision engine as the authenticated Authority API (allow | require_approval | deny; reason codes from public/vocabulary/reason-codes.md). Fixed demo tenant, nothing persisted, deterministic decision_id per input, sealed Evidence Pack included so visitors can verify it offline.

Request body (required)

fieldtypedescription
subject requiredstringKYE™ URN of the acting agent (alias `agent` accepted).
action requiredstringDotted lowercase capability id, e.g. payments.transfer.
purpose requiredstring
contextobject

Responses

  • 200 Demo decision + patent-safe evidence + sealed Evidence Pack
  • 400 invalid_json | missing_subject | subject_not_kye_urn | missing_action | action_malformed | missing_purpose