Licensed to be used in conjunction with basebox, only.
// integration
Integrations & API
Applies to
Product: Cloud · Server · Audience: Developer / Integrator
This section is for everyone who integrates basebox into software and business systems: developers using the OpenAI-compatible or the REST API, teams connecting MCP servers, and IT connecting basebox to an identity provider, mail, SIEM or business applications.
It deliberately contains no infrastructure operations. Installation, GPUs, Kubernetes and Helm are under Developer → Installation & Operations.
What you need
Two things suffice for the API: an API key, issued by an administrator of your organisation under Administration → API keys, and the base URL of your environment – in basebox Cloud https://aims.basebox.ai, on basebox Server the domain of your installation. Plus the X-Realm header with your organisation's realm – in the Cloud the subdomain under which your organisation uses basebox. Everything else is in the Quickstart.
In this section
API
| Page | Content |
|---|---|
| Quickstart | Your first chat completion in a few minutes – with curl and with the OpenAI SDK |
| Authentication | Bearer token and X-Realm, differences Cloud/Server |
| OpenAI-compatible API | /v1/chat/completions, /v1/models, Swagger UI, IDE and OpenClaw integration |
| REST API | /rest/v1/chat/completions and the reference |
| Streaming | Server-Sent Events, what a client has to handle, reasoning in the stream |
| Error handling | Status codes, messages and recommended client behaviour |
MCP and connectors
| Page | Content |
|---|---|
| MCP overview | What the Model Context Protocol is in basebox; the shipped connectors |
| MCP client | How the assistant discovers, selects and calls tools and frames results |
| Connect an MCP server | Registering an MCP server – in the interface or via Helm |
| Authorization flow | Per-user credentials, access-control gate, security properties |
| Build connectors | Architecture, authentication, read/write access, permissions, examples |
Enterprise integration
| Page | Content |
|---|---|
| Overview | What applies equally to Cloud and Server – and what does not |
| LDAP / OIDC · SIEM · SMTP · VPN / networking · Business systems | Identity, audit forwarding, mail, network paths, connecting business applications |
The historical entry point to the technical documentation is Technical documentation (entry).
Two principles
Permissions stay with the source system. When the assistant accesses an external system through a connector, it does so with the respective person's credentials. basebox neither copies nor extends permissions.
Tool results are data, not instructions. Everything that comes back from a connector or web search is framed as data. Build connectors so that they return structured, bounded results.
Cloud or Server – what changes?
Little. Base URL and X-Realm differ; on a server the REST API must be enabled via AISRV_ENABLE_REST_API, and connector services are deployed in the cluster by the Platform Operator. Enterprise integrations apply to both products, but network connectivity is established once from the customer network and once from the basebox environment – see Enterprise integration.
Need help? Contact support