API reference
Everything the console does, it does through this API, so anything you can click, a program can do. These pages
are generated from the document a running appliance serves at /v3/api-docs, and republished whenever it changes.
They are never written by hand. The raw document is openapi.json, and it is the one to build a
generated client from.
Where it is
Section titled “Where it is”Your world answers on your own machine, at the console’s address: http://localhost:11044 unless you changed the
port. Every path in these pages starts there.
Signing in
Section titled “Signing in”Every endpoint needs one of two credentials:
- An API key, minted in the console under Settings, then API keys. Send it as
X-Embabel-Api-Key: <key>, or asAuthorization: Bearer <key>. This is the one for programs and agents, and you can revoke it at any time. - Your own account, with HTTP Basic. The console signs in this way.
Asking it from code
Section titled “Asking it from code”If all you want is answers, you may not need these pages at all. Your world is also an OpenAI-compatible model, so
LangChain, the Vercel AI SDK, Embabel and any other OpenAI client can ask it with an address, a key and the model
name world. See Chat and models for that door’s endpoints.
The groups
Section titled “The groups”- Realms and queries: realms, Virtual Cypher, saved views and the watches on them.
- Knowledge graph: documents, facts and the graph built from them.
- Chat and models: asking the world, and the models that answer.
- Agents: agents, their runs, skills, actions and schedules.
- Keys and sign-in: signing in, and API keys.
- Your world: setup, configuration, health and activity.
- Everything else: what belongs to no group yet.

