Licensed to be used in conjunction with basebox, only.
// integration
basebox REST API - Overview
Applies to
Product: Cloud · Server · Audience: Developer / Integrator
basebox provides a REST API that allows integration of 3rd party systems and services. It complies to the OpenAI REST API, although it does not support all endpoints and features.
If you miss anything, please send your request to support@bbox.
Base URL
All REST API requests use one of the following base URLs, depending on your deployment:
| Deployment | Base URL |
|---|---|
| Cloud | https://aims.basebox.ai/rest/v1 |
| basebox Server | https://<dein-ingress-host>/rest/v1 |
On basebox Server, replace <dein-ingress-host> with the ingress host of your basebox instance (usually the hostname you use to access the basebox.ai frontend).
Prerequisites
The REST API is an optional feature; your basebox license must cover its use. On basebox Server, you must also ensure that the environment variable AISRV_ENABLE_REST_API is set to true.
Authentication
Authentication is required for all requests to the REST API. You can authenticate using an API key passed to the server as a bearer token. You create API tokens in the basebox administration panel.
For more information, see the Authentication section.
API Host
For cloud users, the API host is aims.basebox.ai; on basebox Server ask your platform operator. Usually, you can use the hostname that you use to access the basebox.ai frontend.
The path to the REST API is always /rest/v1.