Use the public API
Create a personal key, browse OpenAPI documentation and automate the same operations as the portal.
The public API automates the same business operations as the portal, within the permissions of the account that owns the key.
Create a key
- Open your profile menu.
- Choose API keys.
- Create a key and immediately store it in your secrets manager.
- Revoke any key that is no longer used.
A key does not grant additional permissions. If its owner's roles or access change, API calls use the new scope.
Browse OpenAPI
Choose API documentation from the profile or keys page. Routes unavailable to the signed-in user are hidden.
Each operation documents:
- accepted fields and their format;
- required values;
- JSON body examples;
- possible responses and errors;
- expected permissions.
Configure a bot through sub-resources
Bot configuration is divided into specialised routes to avoid an excessively large request body: identity, AI, SIP, protection, skills and integrations. Use the sub-route for the part you are actually changing.
Best practices
- Never embed a key in browser-side code.
- Use HTTPS.
- Handle errors and rate limits.
- Test in the development environment.
- Do not log secrets or complete personal data.