The Bold360 ai API is based on HTTP and uses JSONP (JSON with Padding) for accessing cross-domain resources.
The requests return a JSON object along with standard HTTP response codes, including error indication.
When making an API request, please make sure it is sent over HTTPS only, otherwise it will fail and return an error.
API requests made without the correct authentication ( API KEY ) will also fail.
When creating an API key be sure to include the desired permission settings and IP ranges prior to clicking "Save".
Please note: for troubleshooting and exception handling, the JSON response body will indicate the error.
The Bold360 ai API Base URL:
Certain requests must include your specific account preceded with the tilde sign ( ~ ).
An API key is a unique identifier that is used for authenticating your requests, it is possible to generate multiple API keys with different permissions for security reasons.
Make sure to keep the API keys secret, please see the guide on generating an API key for more details.
A number of API queries require new sessions to be created in order to perform the request. The session creation process generates a session ID which will need to be assigned to the given request.
If you are making batch requests, it is also possible to close the specific session ID, or to keep it alive for the duration of time used.
Please note: All search and voice analytics are processed when a session ends.
The following API requests require a session:
- Auto Complete,
- Get Article By Id
- Set Context & Form values
- Report Channeling(session)
- Report feedback (Like/Dislike)
- Increment article statistics
- Session keep-alive
- Close a session
- Track Event
- Translate text
- Request contact form file upload
- Get Ticket Info