Subject-Emu-5259 commited on
Commit
09aa231
·
verified ·
1 Parent(s): f0508d5

docs: add BYO API / ZO Computer BYOK setup (Base URL + model id neuralai)

Browse files
Files changed (1) hide show
  1. README.md +11 -0
README.md CHANGED
@@ -302,3 +302,14 @@ The standalone software implementation of this core is **NeuralLabs**:
302
  The latest beta builds (v0.1-Beta) of NeuralLabs are available at:
303
  👉 **[https://zo.pub/deandrewharris/neurallabs-beta](https://zo.pub/deandrewharris/neurallabs-beta)**
304
  # NeuralAI → Hugging Face sync is live
 
 
 
 
 
 
 
 
 
 
 
 
302
  The latest beta builds (v0.1-Beta) of NeuralLabs are available at:
303
  👉 **[https://zo.pub/deandrewharris/neurallabs-beta](https://zo.pub/deandrewharris/neurallabs-beta)**
304
  # NeuralAI → Hugging Face sync is live
305
+
306
+ ## 🔌 Use NeuralAI as an OpenAI-compatible backend (BYO API / ZO Computer BYOK)
307
+
308
+ NeuralAI exposes an OpenAI-compatible chat API so it can power other chat UIs — including **ZO Computer's Bring Your Own Key (BYOK)**.
309
+
310
+ - **Base URL**: `https://neuralai-web-ui-deandrewharris.zocomputer.io/v1`
311
+ - **Model id**: `neuralai`
312
+ - **Auth**: Personal API key (generate in NeuralAI Settings → Developer/API Access). Keys are hashed and revocable.
313
+ - **Endpoints**: `POST /v1/chat/completions` (SSE streaming + non-streaming JSON, CORS-enabled) and `POST /v1/models`. `GET` probes on these paths return `200` so host validation passes.
314
+
315
+ Full setup walkthrough: [`docs/BYOK_ZO_INTEGRATION.md`](https://github.com/Subject-Emu-5259/NeuralAI/blob/master/docs/BYOK_ZO_INTEGRATION.md).