REST API
To use this integration you will need either an Organisation or User API token.
Our REST API is the easiest way to integrate Mimir into your ecosystem.
List Organisation Users
This endpoint requires organisation token (opens in a new tab)
Retrieve a list of all the users in your organisation.
Get user request
GET - Query organisation users
curl --location 'https://api.askmimir.io/api/v1/users' \
--header 'Authorization: Bearer <REPLACE_WITH_API_KEY>'Get user response
Query organisation users JSON response
{
"users": [],
"pagination": {
"limit": 100,
"page": 0
}
}Get user path parameters
| page | 0 | Pagination index (starts at 0) |
| limit | 100 | Max items per page (min 0 - max 100) |
Get user response body
| users | Object | User object |
| pagination | Object | Pagination object |
List Knowledge Bases
This endpoint requires organisation token (opens in a new tab)
Retrieve a list of all the knowledge bases in your organisation.
Get knowledge bases request
GET - Query organisation knowledge-bases
curl --location 'https://api.askmimir.io/api/v1/knowledge-bases' \
--header 'Authorization: Bearer <REPLACE_WITH_API_KEY>'Get knowledge bases response
Query organisation knowledge-bases JSON response
{
"knowledge-bases": [],
"pagination": {
"limit": 100,
"page": 0
}
}Get knowledge bases parameters
| page | 0 | Pagination index (starts at 0) |
| limit | 100 | Max items per page (min 0 - max 100) |
Get knowledge bases body
| knowledge bases | Object | Knowledge bases object |
| pagination | Object | Pagination object |
Query Knowledge Base
Query a knowledge bases in your organisation.
Query knowledge bases request
GET - Query organisation knowledge-bases
curl --location 'https://api.askmimir.io/api/v1/knowledge-bases' \
--header 'Authorization: Bearer <REPLACE_WITH_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"query": "<REPLACE_WITH_QUERY>"
}'Query knowledge bases response
Query organisation knowledge-bases JSON response
{
"query": "query",
"response": "response",
"credits-used": 1
}Query knowledge bases path parameters
| page | 0 | Pagination index (starts at 0) |
| limit | 100 | Max items per page (min 0 - max 100) |
Query knowledge bases response body
| query | String | User requested knowledge bases query |
| response | String | User requested knowledge base response (max 400 characters) |
| credits | Number | Number of credits used for the query |