This section covers how to set up and utilise the Awaken Cloud API to ingest voice and text conversation data.
Before the API can be used, credentials will need to be requested from Awaken Intelligence, and you will need to make use of the appropriate regional endpoint.
Region Endpoints
Throughout the child articles the regional endpoint will be referenced. You will be informed of which endpoint to use when signing up.
You will be requested by the Awaken Helpdesk for the following information:
Master Email address to receive and manage API access (it is recommended that this be a specifically created email address rather than using a individuals email address)
Region
Context (e.g. Production or Development)
2) Receive and Configure API User
The Awaken team will generate an API user from the provided details at which point the provided email address will receive an automated email with the initial credentials for the API user, as well as a link to set the operational password
3) Authenticate
Using the specified password and provided username you can now proceed to authenticate against the desired API.
Forgotten Password
Note
The following process is not part of the initial setup, it is only to be used if you have forgotten your password.
If a reset password is required, there are two steps to follow: Requesting a password reset, and providing a new password
POST
/v1/auth/forgotPassword
Request
curl --location --request POST '{{Region Endpoint}}/v1/auth/forgotPassword' \
--header 'Content-Type: application/json' \
--data-raw '{
"Username":"{{API USERNAME}}"
}'
Response
Success
{
"RequestId": "{{RequestId}}",
"Success": true,
"Version": "x.x.x.x"
}
Following the above API request, an email will be sent to the user name, which will contain a code to be used in the following API call
POST
/v1/auth/confirmForgotPassword
Request
curl --location --request POST '{{Region Endpoint}}/v1/auth/confirmForgotPassword' \
