OBT Live Engage AI - Management API Microservice Microservice
Introduction
This API contains endpoints which enable management of your Engage AI instance.
It is intended to be accessed by LiveOps operators and backend system integrations.
Logging in
Use of this API requires that requests are authenticated (with the exception of the Health Check endpoint).
To login, use the /auth/login endpoint, with your Operator username/password
Tip: to create a sha of your password, run the following cmd
echo -n 'my-secure-password' | sha256sum
This should return you a JWT which you can use for Authorizing further requests.
Client Libraries
Coming soon
Authentication
- API Key: x-api-key-id
- API Key: x-api-key-secret
- HTTP: Bearer Auth
An API Key ID in the x-api-key-id header
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | x-api-key-id |
An API Key Secret in the x-api-key-secret header
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | x-api-key-secret |
A JWT provided as a token in the Authorization header
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |