Skip to content

Quick Summary

For the impatient, here's a quick summary of the REST API:

Host

https://aims.basebox.ai for cloud users, or ask your system administrator for on-premise installations.

Path

/rest/v1, e.g. https://aims.basebox.ai/rest/v1 for the cloud.

Authentication

Bearer token; API tokens are created in basebox' admin panel

Headers

Content-Type: application/json
X-Realm: <your_org_subdomain> - set to your org's subdomain (cloud) or primary for on-premise installations. See Authentication for more details.