Knowledge capability · Remote provider
Connect your knowledge where it lives.
Give E Hub a Base URL and a one-time verification key. Project metadata and manifest are managed centrally on the Hub, with automatic OpenAPI discovery.
Quick start
Expose /verify
Expose POST /api/e/verify (or /verify) on your server with your E_PUBLISHER_API_KEY.
Expose OpenAPI or /retrieve
Host your API spec at GET /api/openapi.json or implement standard POST /retrieve.
Verify & Publish
Enter your Base URL in the publisher workspace and click Verify and publish.
Use the provider SDK
@vxnus/e-provider handles ownership verification and optional search validation. Remote providers do NOT host manifests—the Hub manages authoritative pack metadata.
import { createKnowledgeProvider } from "@vxnus/e-provider";
export const provider = createKnowledgeProvider({
identity: { id: "@vxnus/e-teyvat", publisher: "vxnus" },
verificationKey: process.env.E_PUBLISHER_API_KEY!,
// Optional: retrieve: async (request) => searchKnowledge(request.query),
});
// Handle verification handshake from E Hub at /api/e/verify or /verify
provider.handlers.verify(request.headers.authorization);Endpoints & Smart Discovery
When you provide a Base URL (e.g. https://eteyvat.vxnus.xyz), E Hub verifies your provider and discovers endpoints automatically:
POST /api/e/verifyMANDATORY: Handshake verifying your E_PUBLISHER_API_KEY (also supports /verify).GET /api/openapi.jsonRECOMMENDED: Auto-discovered OpenAPI specification describing your custom endpoints.POST /api/e/retrieveOPTIONAL: Standard E lexical/semantic search (required if no OpenAPI contract is provided).OpenAPI Specification
Serving an OpenAPI spec at /api/openapi.json allows E-compatible AI to automatically discover and call your custom knowledge endpoints.
{
"openapi": "3.1.0",
"info": { "title": "E-Teyvat Knowledge API", "version": "1.0.0" },
"paths": {
"/api/entities": { "get": { "summary": "Search game entities" } },
"/api/farming": { "get": { "summary": "Farming source locations" } }
}
}Authoritative Hub Manifest
Manifest metadata, licensing, sources, and capability declarations are created and edited in your project settings on E Hub, stored immutably in the registry.
{
"id": "@vxnus/e-teyvat",
"name": "e-teyvat",
"publisher": "vxnus",
"version": "1.0.1",
"schemaVersion": "1.0",
"license": { "license": "CC-BY-4.0", "licenseName": "Creative Commons Attribution 4.0 International", "licenseUrl": "https://creativecommons.org/licenses/by/4.0/" },
"sources": [{ "id": "teyvat", "title": "Teyvat Archive", "license": "CC-BY-4.0", "licenseUrl": "https://creativecommons.org/licenses/by/4.0/" }],
"capabilities": { "lexicalSearch": true, "semanticSearch": true, "structuredEntities": true, "relations": true, "revisions": true },
"apiContract": { "openapi": "3.1.0", "paths": { "/api/entities": { "get": {} }, "/api/farming": { "get": {} } } }
}Verification rules
401Invalid key
The key is missing, revoked, or incorrect.
403Wrong provider
The key is valid but belongs to another provider identity.
400Inaccessible Knowledge
The provider must expose either a working POST /retrieve or an OpenAPI contract.
The Hub stores the public URL, verification state, and project manifest. Never include the private key in a client bundle or log.