Skip to content

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.

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.

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 as Authorization: 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.

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.