Licensed to be used in conjunction with basebox, only.
// start
Developer / Integrator
You integrate basebox into software and business systems: through the OpenAI-compatible API, the REST API, MCP servers and your own connectors. Your area is Developer.
What you need – and what you do not
To work with the API you need exactly two things: an API key, issued by an administrator of your organisation, and the base URL of your basebox environment. Kubernetes, Helm, GPU drivers and inference configuration belong to the Platform Operator – you do not need to know any of it to integrate.
Typical tasks
| Task | Entry page |
|---|---|
| Your first chat completion in a few minutes | Quickstart |
Set token and X-Realm header correctly |
Authentication |
| Connect existing OpenAI clients and tools | OpenAI-compatible API · User guide |
| Connect an editor or coding agent | IDE integration · OpenClaw integration |
| Stream responses, handle reasoning content | Streaming |
| Handle errors cleanly | Error handling |
| Look up the REST API endpoints | REST API · Endpoints |
| Understand how the assistant calls tools | MCP overview · MCP client |
| Connect your own MCP server | Connect an MCP server |
| Build a connector that fits basebox | Build connectors |
Two things you should know about basebox
Permissions stay with the source system. When the assistant reaches an external system through a connector, it does so with the credentials of the respective user. basebox neither copies nor extends permissions. The full flow is described under Authorization flow – read it before designing a connector.
Tool results are data, not instructions. basebox frames everything that comes back from a connector or web search as data. Build your connectors so that they return structured, bounded results – see Read access.
How this role differs from the others
- The API key is issued by an Administrator; you do not manage it in the interface.
- Whether a self-built MCP server runs in the cluster and how it is deployed there is decided by the Platform Operator – see Deploying MCP connectors with Helm.
- Which connectors are actually available to users in the chat is controlled by the administrator per organisation and per app.
Cloud or Server – what changes for you?
Little. The base URL and the value of the X-Realm header differ (Cloud: your organisation's subdomain; Server: usually primary). On a server the REST API additionally has to be enabled via AISRV_ENABLE_REST_API. Details under Authentication.