Get started
Quick start guide
Generate an authorisation token
At Mimir, we use access tokens to integrate with external tools, allowing you to build a custom ecosystem tailored to your business's unique needs. Tokens grant you access to Mimir's API resources, with permissions determined by your token type (organisation or user), role, and assigned scopes. When sending API requests, include your access token in the Authorisation header, prefixed by the word "Token" followed by a space and the token value:
Authorization: {Your authentication token}Select the endpoint that corresponds to the resource you want to interact with
Each platform guide outlines the path parameters and response body needed for your selected request, complete with a valid example. You can filter by available language options to find the example that best aligns with your framework.
Rest API: Guide (opens in a new tab)
For example: Get knowledge bases (opens in a new tab)
Evaluating response codes
The API returns 200 OK or 201 CREATED for all successful request. If your request failed, you will receive an error code. Refer to Troubleshooting or error handling guides to troubleshoot the issue.
Integrations
Using Mimir can vary slightly based on the frameworks and tools you're working with. To assist you, we've compiled guides covering common setups.
Don’t see your favorite tool in the list? We’re are working on new integrations and guides, but in the mean time you can follow the instructions for using Mimir with RESTful api, which is compatible with most platforms.
Tutorials
Learning a new platform can be daunting, so we have created some bitesize tutorials to make adoption easier. We are continuously working on new integration and feature, so if you see a feature you want to know more about it will be documented in our tutorials section.
