Developers
API overview
How the MantraWorx API works: the base URL, JSON, the token header and a first request.
On this page
The MantraWorx API is a JSON API over HTTPS. The web app uses the same API, under the /api path of your MantraWorx host.
Note: What you can call depends on your role. Every request is checked against your permissions, so a call that works for an administrator can return 403 for another user.
The basics#
| Item | Value |
|---|---|
| Base URL | https://<your-host>/api |
| Format | JSON requests and responses. Send Content-Type: application/json. |
| Authentication | Authorization: Bearer <accessToken>. Browsers use an HttpOnly cookie instead. |
| Request size | JSON bodies up to 10 MB by default. File uploads use multipart/form-data. |
| Errors | A JSON body with an error field, and usually a message. |
Replace <your-host> with the address you use to open MantraWorx.
Your first request#
Sign in to get a token, then use it on any other call. The next page covers sign-in in detail.
Where to go next#
- Authentication: sign in, use the token and sign out.
- Roles and permissions: how access is decided.
- Documents API: list, read, create and update documents.
- Errors and rate limits: status codes and how to retry.
Need more help?
Can’t find what you need? Talk to the team.