Bold360 AI REST API and SDK Reference
What is the Bold360 AI REST API and SDK Reference?
This is the Bold360 AI REST API and SDK Reference. The REST API Calls and SDK link at the top of this page contains explanations for each REST API call in Bold360 AI versions v2 and v1. A download is provided at the bottom of that linked page.
Who should read this reference?
Intermediate, advanced, and expert developers can use this reference to look up REST API call usage. If you are a beginning developer or new to Bold360 AI, we recommend that you first walk through the Quickstarts section then return here once you master that information.
What are the prerequisites for calling the REST API?
The two things you need to call the REST API are a license (to provide an account) and knowledge how to call REST APIs. For more information, please see the more detailed Prerequisites section.
The following shows the format of the URL for calling the API.
The URL format shows that all REST API calls must contain Protocol, Sub-domain Name, Domain Name, and Path. For example, if the account (Sub-domain Name) is myAccount, the domain (Domain Name) is myDomain, and the full REST API call endpoint (Path) is /api/kb/v1/createArticle, the entire URL to use is https://myAccount.myDomain/api/kb/v1/createArticle. Most of the time, the Domain Name is nanorep.co, but it is possible it could be different, so please check with your system administrator.
HTTP status codes returned in the server's response
The server's response to your REST API call returns an HTTP status code to indicate whether your REST API call was successfully completed. For more information, please see HTTP Status Codes.