@oasisomniverse/web6-api 1.0.0

package/docs/modules/HolonicMemory.md

@@ -0,0 +1,268 @@
+# HolonicMemory — `web6.holonicMemory`
+
+Source controller: [`HolonicMemoryController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/HolonicMemoryController.cs)
+Route prefix: `v1/holonic-memory`
+5 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `getEarthHolon`
+
+The Holonic BRAID fractal memory hierarchy - Session → Agent → User → Group → Neighbourhood → District → City → County → Country → Continent → Earth. Create/get holons at any level, set the membrane rule that governs what propagates upward, record memory, and trigger propagation one hop at a time.
+
+**GET** `v1/holonic-memory/earth`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `HolonicMemoryHolonDto`
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `Level` | `Enums.HolonicMemoryLevel` |
+| `ParentHolonId` | `Guid` |
+| `Name` | `string` |
+| `MemoryItems` | `List<HolonicMemoryItem>` |
+| `MembraneRule` | `MembraneRule` |
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.holonicMemory.getEarthHolon({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Level": /* <Enums.HolonicMemoryLevel> */, "ParentHolonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "MemoryItems": [{ "FieldName": "example string", "Value": "example string", "Tags": ["example string"], "CreatedUtc": "2026-01-01T00:00:00Z" }], "MembraneRule": { "FieldsAllowedToPropagate": ["example string"], "Retention": /* <Enums.RetentionPolicy> */, "WhoCanRead": [ /* <System.Guid> */ ], "TriggerCondition": "example string", "AnonymisedAggregateOnly": true } }
+}
+```
+
+---
+
+### `getOrCreateHolon`
+
+**POST** `v1/holonic-memory/holons`
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `level` | `HolonicMemoryLevel` |
+| `name` | `string` |
+| `parentHolonId` | `Guid` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `HolonicMemoryHolonDto`
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `Level` | `Enums.HolonicMemoryLevel` |
+| `ParentHolonId` | `Guid` |
+| `Name` | `string` |
+| `MemoryItems` | `List<HolonicMemoryItem>` |
+| `MembraneRule` | `MembraneRule` |
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.holonicMemory.getOrCreateHolon({
+    level: '<level>',
+    name: 'example string',
+    parentHolonId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Level": /* <Enums.HolonicMemoryLevel> */, "ParentHolonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "MemoryItems": [{ "FieldName": "example string", "Value": "example string", "Tags": ["example string"], "CreatedUtc": "2026-01-01T00:00:00Z" }], "MembraneRule": { "FieldsAllowedToPropagate": ["example string"], "Retention": /* <Enums.RetentionPolicy> */, "WhoCanRead": [ /* <System.Guid> */ ], "TriggerCondition": "example string", "AnonymisedAggregateOnly": true } }
+}
+```
+
+---
+
+### `propagate`
+
+Propagates whatever the child holon's membrane rule permits up to its parent (a single hop).
+
+**POST** `v1/holonic-memory/holons/{childHolonId}/propagate`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `childHolonId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `int`
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.holonicMemory.propagate({
+    childHolonId: '<childHolonId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": 1
+}
+```
+
+---
+
+### `recordMemory`
+
+**POST** `v1/holonic-memory/holons/{holonId}/memory`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `holonId` | `Guid` |
+
+**Request**
+
+Body type: `HolonicMemoryItem`
+
+| Field | Type |
+| --- | --- |
+| `FieldName` | `string` |
+| `Value` | `string` |
+| `Tags` | `List<string>` |
+| `CreatedUtc` | `DateTime` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `bool`
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.holonicMemory.recordMemory({
+    holonId: '<holonId>',
+    fieldName: "example string",
+    value: "example string",
+    tags: ["example string"],
+    createdUtc: "2026-01-01T00:00:00Z"
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": true
+}
+```
+
+---
+
+### `setMembraneRule`
+
+**PUT** `v1/holonic-memory/holons/{holonId}/membrane-rule`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `holonId` | `Guid` |
+
+**Request**
+
+Body type: `MembraneRule`
+
+| Field | Type |
+| --- | --- |
+| `FieldsAllowedToPropagate` | `List<string>` |
+| `Retention` | `Enums.RetentionPolicy` |
+| `WhoCanRead` | `List<System.Guid>` |
+| `TriggerCondition` | `string` |
+| `AnonymisedAggregateOnly` | `bool` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `bool`
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.holonicMemory.setMembraneRule({
+    holonId: '<holonId>',
+    fieldsAllowedToPropagate: ["example string"],
+    retention: /* <Enums.RetentionPolicy> */,
+    whoCanRead: [ /* <System.Guid> */ ],
+    triggerCondition: "example string",
+    anonymisedAggregateOnly: true
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": true
+}
+```
+

package/docs/modules/Images.md

@@ -0,0 +1,77 @@
+# Images — `web6.images`
+
+Source controller: [`ImagesController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/ImagesController.cs)
+Route prefix: `v1/images`
+1 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `generate`
+
+Generates an image via the requested provider (StabilityAI or OpenAI). POST https://api.web6.oasisomniverse.one/v1/images/generate
+
+**POST** `v1/images/generate`
+
+**Request**
+
+Body type: `ImageGenerationRequest`
+
+| Field | Type |
+| --- | --- |
+| `Prompt` | `string` |
+| `Provider` | `AIProviderType` |
+| `Model` | `string` |
+| `Size` | `string` |
+| `AspectRatio` | `string` |
+| `OutputFormat` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `ImageGenerationResponse`
+
+| Field | Type |
+| --- | --- |
+| `Provider` | `string` |
+| `Model` | `string` |
+| `ImageBase64` | `string` |
+| `OutputFormat` | `string` |
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.images.generate({
+    prompt: "example string",
+    provider: {  },
+    model: "example string",
+    size: "example string",
+    aspectRatio: "example string",
+    outputFormat: "example string"
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "Provider": "example string", "Model": "example string", "ImageBase64": "example string", "OutputFormat": "example string" }
+}
+```
+

package/docs/modules/Orchestrator.md

@@ -0,0 +1,173 @@
+# Orchestrator — `web6.orchestrator`
+
+Source controller: [`OrchestratorController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/OrchestratorController.cs)
+Route prefix: `v1/orchestrators`
+3 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `getAdapters`
+
+**GET** `v1/orchestrators`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `OrchestratorAdapterConfig` (array)
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `Name` | `string` |
+| `Protocol` | `OrchestratorProtocolType` |
+| `EndpointUrl` | `string` |
+| `AuthToken` | `string` |
+| `ExtraConfig` | `Dictionary<string, string>` |
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.orchestrator.getAdapters({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": [{ "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "Protocol": {  }, "EndpointUrl": "example string", "AuthToken": "example string", "ExtraConfig": { "<string>": "example string" } }]
+}
+```
+
+---
+
+### `invoke`
+
+**POST** `v1/orchestrators/invoke`
+
+**Request**
+
+Body type: `OrchestratorInvokeRequest`
+
+| Field | Type |
+| --- | --- |
+| `AdapterId` | `Guid` |
+| `Input` | `string` |
+| `Parameters` | `Dictionary<string, object>` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `OrchestratorInvokeResponse`
+
+| Field | Type |
+| --- | --- |
+| `AdapterName` | `string` |
+| `Protocol` | `OrchestratorProtocolType` |
+| `Output` | `string` |
+| `LatencyMs` | `long` |
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.orchestrator.invoke({
+    adapterId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+    input: "example string",
+    parameters: { "<string>": {} }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "AdapterName": "example string", "Protocol": {  }, "Output": "example string", "LatencyMs": 1 }
+}
+```
+
+---
+
+### `registerAdapter`
+
+Aggregates every agent protocol/orchestration framework (MCP, A2A, LangChain, AutoGen, CrewAI, Semantic Kernel, or any generic webhook) behind WEB6's unified interface. Register an external orchestrator once, then invoke it the same way you'd call any AI provider through /v1/complete.
+
+**POST** `v1/orchestrators`
+
+**Request**
+
+Body type: `OrchestratorAdapterConfig`
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `Name` | `string` |
+| `Protocol` | `OrchestratorProtocolType` |
+| `EndpointUrl` | `string` |
+| `AuthToken` | `string` |
+| `ExtraConfig` | `Dictionary<string, string>` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `OrchestratorAdapterConfig`
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `Name` | `string` |
+| `Protocol` | `OrchestratorProtocolType` |
+| `EndpointUrl` | `string` |
+| `AuthToken` | `string` |
+| `ExtraConfig` | `Dictionary<string, string>` |
+
+**Example**
+
+```js
+const { isError, message, result } = await web6.orchestrator.registerAdapter({
+    id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+    name: "example string",
+    protocol: {  },
+    endpointUrl: "example string",
+    authToken: "example string",
+    extraConfig: { "<string>": "example string" }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "Protocol": {  }, "EndpointUrl": "example string", "AuthToken": "example string", "ExtraConfig": { "<string>": "example string" } }
+}
+```
+