---
title: "KYE Protocol™ — Native Engines API | API reference"
description: "KYE Protocol™ — Native Engines API: 12 operations from native-engines.openapi.yaml, a published KYE Protocol™ OpenAPI contract."
url: https://kyeprotocol.com/developers/api/native-engines/
lang: en
source: "KYE Protocol"
---

> KYE Protocol™ — Native Engines API: 12 operations from native-engines.openapi.yaml, a published KYE Protocol™ OpenAPI contract.

API reference

# KYE Protocol™ — Native Engines API

12 operations · `native-engines.openapi.yaml`

**Servers**

`https://api.kyeprotocol.com`

**Version**

1.0.0

**Source**

[native-engines.openapi.yaml](https://kyeprotocol.com/developers/api/native-engines.openapi.yaml)

Public REST surface for the four named sub-engines:

KYE™ Data Mapping Agent™ · `/v1/data-flow` KYE™ Native Search Engine™ · `/v1/search` KYE™ Memory Engine™ · `/v1/memory` KYE™ Reporting Engine™ · `/v1/reports`

Every endpoint returns a signed envelope replayable offline from the per-tenant published signing key alone. The synthesis construction is part of the patent track and is not disclosed in this repository — what is documented here is the observable contract only.

Base path: `/v1/`. Host: `api.kyeprotocol.com`.

search 2 memory 4 data-flow 2 reports 4

## search

POST `/v1/search` Run a tenant-scoped query against the native search engine.

Returns a signed `kye.search_result.v1` envelope. The construction is part of the patent track and is not disclosed in this repository — only the observable contract (request shape, response envelope, filter inputs) is documented here.

**Auth:** bearerAuth

### Request body (required)

| field | type | description |
| --- | --- | --- |
| `index` **required** | string | One of consultants, partners, widgets, oss-packages, evidence-packs, decisions |
| `q` **required** | string |  |
| `classification_floor` | string | Rows above the caller's floor are silently withheld and counted. |
| `risk_tier_max` | string | One of minimal, limited, high, unacceptable, prohibited |
| `limit` | integer |  |
| `offset` | integer |  |
| `mode` | string | One of lexical, semantic, hybrid |

### Responses

- `200` Signed search result envelope.
- `400` Bad request (unknown index / empty query).
- `401` Missing bearer token.
- `402` Entitlement missing (capability=search.read not in active SKU).
- `403` Tenant suspended or key revoked.

GET `/v1/search/runs` List the caller tenant's last 100 search runs (WORM-persisted).

**Auth:** bearerAuth

### Responses

- `200` search\_query\_log rows.

## memory

GET `/v1/memory` List the caller tenant's non-forgotten memory records.

**Auth:** bearerAuth

### Responses

- `200` Memory record list.

POST `/v1/memory` Write a signed agent-memory record.

**Auth:** bearerAuth

### Request body (required)

| field | type | description |
| --- | --- | --- |
| `agent_entity_id` **required** | string |  |
| `memory_class` **required** | string | One of preference, observation, fact, evaluation, recall\_hint |
| `purpose` **required** | string | Declared purpose; cross-purpose recalls are denied at the gate. |
| `content` **required** | object |  |

### Responses

- `200` Signed memory envelope.

POST `/v1/memory/recall` Recall under a declared purpose; cross-purpose reads are denied.

**Auth:** bearerAuth

### Request body (required)

| field | type | description |
| --- | --- | --- |
| `agent_entity_id` **required** | string |  |
| `purpose` **required** | string |  |
| `limit` | integer |  |

### Responses

- `200` Recall envelope.
- `403` Cross-purpose recall denied at the gate.

POST `/v1/memory/forget` Tombstone a memory record (WORM-preserved deletion).

**Auth:** bearerAuth

### Responses

- `200` Signed forget envelope.

## data-flow

GET `/v1/data-flow` List recent data-flow seals for the caller tenant.

**Auth:** bearerAuth

### Responses

- `200` Seal list.

POST `/v1/data-flow` Trigger a fresh signed data-flow graph seal.

**Auth:** bearerAuth

### Responses

- `200` Signed kye.data\_flow\_graph.v1 envelope.

## reports

GET `/v1/reports` List the caller tenant's recent reports.

**Auth:** bearerAuth

### Responses

- `200` Report list with count\_this\_quarter + frameworks\_covered KPIs.

POST `/v1/reports` Generate a signed per-framework compliance report.

**Auth:** bearerAuth

### Request body (required)

| field | type | description |
| --- | --- | --- |
| `report_kind` **required** | string | One of soc2\_type2, iso\_27001, iso\_42001, eu\_ai\_act, dora, gdpr, pci\_dss, nist\_800\_207, nist\_ai\_rmf, fedramp, bcbs\_239, sr\_11\_7 |
| `framework` **required** | string |  |
| `period_start` **required** | string |  |
| `period_end` **required** | string |  |

### Responses

- `200` Signed kye.report.v1 envelope.

GET `/v1/reports/{report_id}` Fetch one signed report envelope by id.

**Auth:** bearerAuth

### Parameters

| name | in | type | description |
| --- | --- | --- | --- |
| `report_id` **required** | path | string |  |

### Responses

- `200` Signed kye.report.v1 envelope.

POST `/v1/reports/{report_id}/deliver` Auto-deliver a report envelope via the \`reports@\`-routed mail flow.

**Auth:** bearerAuth

### Parameters

| name | in | type | description |
| --- | --- | --- | --- |
| `report_id` **required** | path | string |  |

### Request body (required)

| field | type | description |
| --- | --- | --- |
| `recipients` **required** | array |  |

### Responses

- `200` Signed kye.report.delivery.v1 receipt.