Bold360 AI REST API & SDK Reference Introduction

This reference documentation describes the Bold360 AI REST API calls and provides an SDK for your use. Your system uses the calls to request the Bold360 AI server to perform an action or return information. The server interacts with the knowledge base. The Bold360 AI Console is where authorized personnel manage the knowledge base.

Regarding this web page

INTERNAL NOTE: Because you specified internal=1 as an URL parameter, you will see sections in this color that are meant for internal LogMeIn staff.

The Expand all button at the upper-right gives you an easy and quick way to expand all collapsed sections in this reference without having to individually expand them. When you click the button, its label changes to Collapse all so you can easily collapse all the sections you just expanded.

NOTE 1: To search for text in this reference, click the Expand all button, and use your browser's Find function.

The navigation menu at the left provides a convenient way for you to locate reference topics.

NOTE 2: At the bottom of the navigation menu is a button to run sample working code. Click the Run in Postman topic to learn more.

Regarding the REST API & SDK

To get more information beyond this reference, please refer to the API & SDK Guide. If you need even more help and support, please see the Official Help. You can also view the previous documentation.

Query/URL parameter key names are case sensitive. Sometimes they aren't, but we recommend you stick to this rule.

The API calls use the nanorep.co domain, because that was the original Bold360 AI product name.

Some of the REST API calls use a query/URL parameter that contains an Interface Source that does not affect the call's response, but instructs the server to track the call by a classification. In this way, you can categorize the traffic in the Bold360 AI Console: Analytics > Reports, choose the Interface field and group. The suggested choices are: API, AutoComplete (for when a user chose a suggestion), direct (for a direct link), Bot, FAQ, Navigation, Link (for Linked Article), Onload, Search, SupportCenter, and your custom value. An example of this is Article - Get by Flexible Search (search). For more information, see the article How to generate a report on interface sources? (ArticleId #1494417791).

When a REST API call returns a time value in .NET milliseconds, you can convert it to UTC depending on your programming language as shown below. An example of this is Article Data - Get (getFullArticleData).

C#

DateTime dt = new DateTime(637124798270840000);
System.Console.WriteLine(dt.ToString("u").Replace(" ", "T")); // 2019-12-20T23:03:47Z
            

Javascript

const ticksToDate = require('ticks-to-date'); // This requires that you first do this:  npm install ticks-to-date
console.log(ticksToDate(637124798270840000)); // 2019-12-20T23:03:47.084Z
            

 

Some REST API calls use base64 values. You can encode and decode base64 strings depending on your programming language as shown below. An example of this is FAQ Articles - Search (faq).

C#

//Encode
byte[] plainTextBytes = System.Text.Encoding.UTF8.GetBytes("deviceType:Android");
string encodedString = Convert.ToBase64String(plainTextBytes);
//Decode
byte[] base64EncodedBytes = System.Convert.FromBase64String(encodedString);
string decodedString = System.Text.Encoding.UTF8.GetString(base64EncodedBytes);
            

Javascript

//Encode
var encodedString = btoa("deviceType:Android");
//Decode
var decodedString = atob(encodedString);
            

INTERNAL NOTE: There are modules in this API that are intentionally omitted from this documentation: Bold360 Acquire, Advise Comments, Advise Tokens, Guidance, and Library Nr. These are considered to be used only by the development team or rarely by other teams. Please use the previous documentation. If you disagree, please contact us.

Accounts

The Accounts REST API calls get information regarding the Bold360 AI Console accounts.
Account - Create (create) INTERNAL ONLY https://{{account}}.{{domainName}}/api/account/v1/create

Description

Create a new account.

Version: 1

Required Permissions for API Key: Highest:Write

HTTPS Only: True

Requires Session: False


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kbLanguage KB Language
name Account Name
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
status customer Account Status: customer, duringTrial, freeTrial, inactive, preTrial
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Account Details - Get (details) INTERNAL ONLY https://{{account}}.{{domainName}}/api/account/v1/details

Description

Return detailed information for the account.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: True

Requires Session: False Example: https://ACCOUNT.nanorep.co/api/account/v1/details?apiKey=API_KEY


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call

Response | Code: 200

{
	"id": "9999900000",
	"reportServiceHost": "https://aSubdomain.aDomain.com",
	"enableAdviseTouchpoints": true
}
                  
Accounts - Get (get) INTERNAL ONLY https://{{account}}.{{domainName}}/api/accounts/v1/get

Description

Get the list of accounts for a user.

Version: 1

Required Permissions for API Key: Highest:Write

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/accounts/v1/get?username=USER_NAME&pw=PASSWORD


URL Parameters

Key Example Value Description
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
API Key - Generate (generateApiKey) INTERNAL ONLY https://{{account}}.{{domainName}}/api/v1/generateApiKey

Description

Generate an API Key for one or all knowledge bases. If the KBName is not specified and the session belongs to an account admin, this applies to all knowledge bases in the account.

Version: 1

Required Permissions for API Key: None

HTTPS Only: True

Requires Session: True

Example: https://


URL Parameters

Key Example Value Description
IPRestriction 0.0.0.0-255.255.255.255 [String] IP ranges to allow access from via the generated API Key.
KBName myKB (REQUIRED if session does not belong to an account admin) [String] Knowledge Base Name
Name AdminApiKey999999999 (REQUIRED) [String] Name of the API Key
Permissions [3,3,3,3,3] (REQUIRED) [JSON Array] Permissions needed to be given to the API Key. JSON array based. [Inbox,KB,Analytics,Voices,RealTimeInteractionData]. 0=None, 1=Read, and 3=Write. Example for read KB and write Voices: [0,1,0,3,0]
Referers [String] Referers to allow access from via the generated API Key.
SessionId 1234567890123456789012 (REQUIRED) [String] Admin/Console based session ID
Conversion - Track (track) http://{{account}}.{{domainName}}/api/conversion/v1/track

Description

Track conversion by conversion Id and step Id, if given, otherwise process all conversion rates.

Required Permissions for API Key: None

Example: http://ACCOUNT.nanorep.co/api/conversion/v1/track?sid=634030922503817052&account=ACCOUNT&orderId=9614748&id=CONVERSION_ID&conversionTag=8jhKn85


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
conversionTag Conversion tag
id Conversion Id
orderId Current order Id
revenue Conversion revenue
sid Conversion step id
File Entity Headers - Get (getEntityHeadersFromFile) INTERNAL ONLY https://{{account}}.{{domainName}}/api/tools/v1/getEntityHeadersFromFile

Description

Get the first N keys for a specific CSV or JSON path, where N=rows.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: True

Requires Session: True

Example: https://ACCOUNT.SERVER/api/tools/v1/getEntityHeadersFromFile?url=URL&apiKey=API_KEY


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
includeJsonArray [Boolean] Whether to include JSON properties in the response
isSingleJsonResponse [Boolean] Determines if the file/Api contains single row
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
requestBody [String] The request HTTP body content, relevant only when requestMethod is 1
requestHeaders KeyValuePair of headers
requestMethod [Number] (Default is 0) HTTP reqeust method: 0 (GET) or 1 (POST)
rows [Number] (Default is 1) Number of Rows
url File path
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Permission - Check (check) INTERNAL ONLY https://{{account}}.{{domainName}}/api/permission/v2/check

Description

Return the account and user IDs for the user's session if the user has the specified permission.

Version: 2

Required Permissions for API Key: None

HTTPS Only: True

Requires Session: True

Example: https://ACCOUNT.nanorep.co/api/permission/v2/check?sid=SulrC4AOOIDN6x4hEc2Kmw&permission=Analytics-Read


URL Parameters

Key Example Value Description
permission Analytics-Read (REQUIRED) [String] Value of permission to check
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Users - Get (getUsers) https://{{account}}.{{domainName}}/api/users/v1/getUsers

Description

Get the list of users for an account.

Version: 1

Required Permissions for API Key: None

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/users/v1/getUsers?apiKey=myApiKey


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).

Response | Code: 200

[
	{
		"id": "1234567890",
		"name": "First Last"
	},
	{
		"id": "1111111111",
		"name": "FirstName LastName"
	}
]
                  
Webhook - Create (webhook) INTERNAL ONLY https://{{account}}.{{domainName}}/api/webhook

Description

Create a webhook, which is a location (url) the Bold360 AI calls when an event occurs, such as a conversation starting. Required Permissions for API Key: Real Time Interaction Data:Write HTTPS Only: True Example: https://ACCOUNT.nanorep.co/api/webhook

URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
type conversation The type of the webhook: conversation
url theDestination.com Your URL: Your website's URL that is initiating this session with the API (aka the referer). Must be unique within an account-hookType combination
webhookApiKey Passed in X-API-KEY header when the hook is invoked
Webhook - Delete (webhook) INTERNAL ONLY http://{{account}}.{{domainName}}/api/webhook

Description

Delete the webhook, specified by the id, from the account.

Required Permissions for API Key: Real Time Interaction Data:Write

HTTPS Only: True

Example: https://ACCOUNT.nanorep.co/api/webhook?apiKey=API_KEY&account=nanorep&id=1


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
id 1 (REQUIRED) [String] Webhook id for deletion
Webhooks - Get (webhook) INTERNAL ONLY https://{{account}}.{{domainName}}/api/webhook

Description

List the webhooks for the account.

Required Permissions for API Key: Real Time Interaction Data:Read

HTTPS Only: True

Example: https://ACCOUNT.nanorep.co/api/webhook?apiKey=API_KEY


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call

Response | Code: 200

[
	{
		"id": 9,
		"type": "conversation",
		"url": "https://aSubDomain.aDomain.com/aid/999999999093162628/ext/nanorep/callback",
		"webhookApiKey": "a95ebcb9-bbee-4702-89b1-999ec0000000"
	}
]
                  

Articles - Manage

The Articles - Manage REST API calls control the Bold360 AI articles.
Article - Create (createArticle) https://{{account}}.{{domainName}}/api/kb/v1/createArticle

Description

Create a new article in the KB.

The title is not unique, so if you issue this exact same request multiple times (i.e, with the same title), the server creates multiple articles with the same title.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: False

Example: https://myAccount.myDomain.com/api/accounts/v1/createArticle

In Postman, the Request Body works as either form-data or x-www-form-urlencoded. Others might work, too.


Request Body (form-data)

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
body

A sample article body

(REQUIRED) [String] The article body, limited to 100k characters
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
externalId 12345 [String] Unique Id from an external system
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
labels A1C93853 [String] The label Ids for the article, in hexadecimal, separated by commas
metaDescription Sample Metadata Description [String] The description for the metadata
metaTitle Sample Metadata Title [String] The title for the metadata
parentId 2721394971 [Number] The Id of the article's Parent article
status kb (REQUIRED) [String] Article Status: kb (online/published) or pc (pending)
successPath https://exampleExistingWebSite.com/index.html [String] Redirect to this existing URL after success instead of returning the JSON response
title A sample title (REQUIRED) [String] The article title

Response | Code: 200

{"status":"success","articleId":2714312291}
                  
Article - Delete (delete) http://{{account}}.{{domainName}}/api/kb/v1/delete

Description

Delete an article

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/kb/v1/delete?articleId=12345&account=ACCOUNT&kb=KbName&apiKey=ApiKey


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
articleId 12345 (REQUIRED if externalId is not specified) [String] Id of the article to update
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
externalId 54321 (REQUIRED if articleId is not specified) [String] Unique Id from an external system
kb myKB {REQUIRED} [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

{"articleDelete":true}

                  
Article - Update (updateArticle) https://{{account}}.{{domainName}}/api/kb/v1/updateArticle

Description

Update an existing article.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: False

Example: https://myAccount.myDomain.com/api/accounts/v1/updateArticle

In Postman, the Request Body works as either form-data or x-www-form-urlencoded. Others might work, too.


Request Body (form-data)

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
articleId 12345 (REQUIRED if externalId is not specified) [String] Id of the article to update
body

A sample article body

(REQUIRED) [String] The article body, limited to 100k characters
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
externalId 54321 (REQUIRED if articleId is not specified) [String] Unique Id from an external system
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
labels A1C93853 [String] The label Ids for the article, in hexadecimal, separated by commas
metaDescription Sample Metadata Description [String] The description for the metadata
metaTitle Sample Metadata Title [String] The title for the metadata
parentId 2721394971 [Number] The Id of the article's Parent article
status kb (REQUIRED) [String] Article Status: kb (online/published) or pc (pending)
successPath https://exampleExistingWebSite.com/index.html [String] Redirect to this existing URL after success instead of returning the JSON response
title A sample title (REQUIRED) [String] The article title

Response | Code: 200

{"status":"success","articleId":12345}
                  
Article Comment - Add (comment) INTERNAL ONLY http://{{account}}.{{domainName}}/api/widget/advise/v1/comment

Description

Add a new article comment


URL Parameters

Key Example Value Description
articleId The id of the article which contains the comment.
comment Comment text.
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
userName myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Article Comment - Delete (deleteComment) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/article/v1/deleteComment

Description

Delete an article comment


URL Parameters

Key Example Value Description
articleId The Id of the article which contains comments.
id The Id of comment to delete.
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
Article Comments - Get by Console Session (getComments) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/article/v1/getComments

Description

Return all article comments for a console session


URL Parameters

Key Example Value Description
articleId The id of the article which contains comments.
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
Article Comments - Get by Widget Session (comment) INTERNAL ONLY http://{{account}}.{{domainName}}/api/widget/advise/v1/comment

Description

Return all article comments for a widget session


URL Parameters

Key Example Value Description
articleId The id of the article.
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
Article Data - Revert (revertArticleData) https://{{account}}.{{domainName}}/api/kb/v1/revertArticleData

Description

Revert the article data to specific revision

HTTPS Only

Required Permissions for API Key: KB:Write


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
articleId 1654002601 (REQUIRED) [String] Article Id: The Id number shown on the page when editing an article (answer) in the Bold360 AI Console's Knowledgebase
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
revisionId The revision Id

Response | Code: 200

{"status":"success"}
                  
Article Draft - Create (createDraft) https://{{account}}.{{domainName}}/api/kb/v1/createDraft

Description

Create a new draft to an article

HTTPS Only

Required Permissions for API Key: KB:Write


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
articleData Json that represent the darft date
articleId Article Id
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

{"status":"success"}
                  
Article Draft - Delete (deleteDraft) https://{{account}}.{{domainName}}/api/kb/v1/deleteDraft

Description

Delete an article draft

HTTPS Only

Required Permissions for API Key: KB:Write


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
articleId 1654002601 (REQUIRED) [String] Article Id: The Id number shown on the page when editing an article (answer) in the Bold360 AI Console's Knowledgebase
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
draftId The draft Id
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

{"status":"remove successfully"}
                  
Article Draft - Update (updateDraft) https://{{account}}.{{domainName}}/api/kb/v1/updateDraft

Description

Update an article draft

HTTPS Only

Required Permissions for API Key: KB:Write


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
articleData Json that represent the darft date
articleId Article Id
draftId The draft to update
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

{"status":"success"}
                  
Article Lock - Release (releaseLock) https://{{account}}.{{domainName}}/api/console/v1/releaseLock

Description

Release an article lock

HTTPS Only

Requires Session: True

Example: https://ACCOUNT.nanorep.co/api/console/v1/releaseLock?sid=SESSIONID&kb=KBNAME&id=123123


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
id Id of the article to unlock
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call

Response | Code: 200

{"unlocked":true}
                  
Article Phrases - Get (phrasingsWithEntitiesMeta) INTERNAL ONLY http://{{account}}.{{domainName}}/api/kb/v1/phrasingsWithEntitiesMeta

Description

Return all phrasing data for an article


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
articleId 2195345701 (REQUIRED) [String] The Article Id
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

[
    {
        "text": "Turn on/off notifications for incoming chats, emails",
        "autoComplete": true,
        "negativeSample": false,
        "entitiesMeta": []
    },
    {
        "text": "Enable chat alerts",
        "autoComplete": true,
        "negativeSample": false,
        "entitiesMeta": []
    }
]
                  
Article Revision Data - Get (getArticleRevisionData) https://{{account}}.{{domainName}}/api/kb/v1/getArticleRevisionData

Description

Get article data in specific revision

HTTPS Only

Required Permissions for API Key:KB:Write


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
articleId 1654002601 (REQUIRED) [String] Article Id: The Id number shown on the page when editing an article (answer) in the Bold360 AI Console's Knowledgebase
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
revisionId The revision Id

Response | Code: 200

{"status":"success"}
                  
Article Text - Find and Replace (FindAndReplace) http://{{account}}.{{domainName}}/api/kb/v1/FindAndReplace

Description

Find and Replace in article body

Required Permissions for API Key: KB:Write

Example: http://ACCOUNT.nanorep.co/api/kb/v1/FindAndReplace?articleId=633915887117827527&account=ACCOUNT&kb=KBNAME&apiKey=APIKEY


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
findInBody If set to true - we only count how many articles are effected and NOT changing the article data
findInTitle If set to true - we only count how many articles are effected and NOT changing the article data
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
replaceInBody replace texts inside the article body
replaceInTitle replace texts in article title
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
verbose If set to true - the response contains the modified article Ids

Response | Code: 200

{"scanned":10, "modified":7, "failed":3, "found":10}
                  
Articles - Import or Update CSV-EXCEL (import) https://{{account}}.{{domainName}}/api/kb/v1/import

Description

Import or Update articles from a CSV/Excel file to the knowledge base.

*HTTPS Only


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
action Import new articles or update existing articles
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
columns List of column types, comma separated (*title and answer are mandatory). The values in the list are from the known values.
failurePath The path for redirect in failuremode. if empty- are the success path
file CSV or Excel file
fileEncoding The encoding for CSV files
ignoreFirstHeaderRow If need to ignore the first row in the file
isPreview Flag if the request is for preview of the data, in preview mode the articles will NOT upload to the knowledge base(only check validation).
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
limitRowCount Limit of articles to import
successPath The path for redirect in success mode
variationsGrouping Flag if need variation grouping.

Response | Code: 200

urlPathToRedirect?importlog={
	"importErrorLog":// for each error- write entry that describe the error
		[         {
		“rowId”:0,
		“message”:
		}, 
		{...},{...}
		],
	“Valid Articles”:,    // how many articles imported
  	“Failed Articles”://how many articles failed
}
                  
Articles - Import or Update JSON (import) https://{{account}}.{{domainName}}/api/kb/v1/import

Description

Import or Update articles from a JSON message.

HTTPS Only

Example: https://ACCOUNT.nanorep.co/api/kb/v1/import?account=ACCOUNT&kb=KbName&apiKey=ApiKey&action=update

Request Body

[
    {
        "title": "This is a test article",
        "answer": "Test article with test body.",
        "label": "test label|label2|this is a test",
        "phrasing": "[{\"text\":\"Test article title2\",\"autoComplete\":true},{\"text\":\"Test article titleN\",\"autoComplete\":false}]",
        "notes": "Some test note.",
        "context": "{\"Device\":\"Android\",\"Country\":\"HU\"}",
        "externalArticleSource": "{\"provider\":\"ServiceNow\",\"id\":\"8b90a662-27a3-4554-be13-39ddec396e3c\",\"version\":3}",
        "expiryDate": "2037-03-15"
    }
]

URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
action update [String] (Default is import) import (Import new articles) or update (Update existing articles)
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
isPreview [Boolean] (Default is false) Flag if the request is for previewing the data. In preview mode, the articles will NOT upload to the knowledge base, because they are only validated.
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

{
	"importErrorLog":[
		{
			"rowId":2,
			"message":"Empty answer title or body"
		}
	],"importedArticles":[
		{
			"internalId":"900804242",
			"externalId":"8b90a662-27a3-4554-be13-39ddec396e3c"
		}
	],
	"Valid Articles":1,
	"Failed Articles":1
}
                  
Dislike Counter - Reset (resetDislikeCounter) INTERNAL ONLY http://{{account}}.{{domainName}}/api/kb/v1/resetDislikeCounter

Description

Reset all dislike counters to zero for the given article


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
articleId Id of the article to reset it's dislike counter
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call

Articles - Search

The Articles - Search REST API calls get information for regular and FAQ articles. You can use these calls to embed information into your web page so that internet search engines can find your articles without using a web widget.

Article - Get by Flexible Search (search) http://{{account}}.{{domainName}}/api/kb/v1/search

Description

Search for articles for the session that match a query.

Version: 1

Required Permissions for API Key: None

Requires Session: True

Example: http://ACCOUNT.nanorep.co/api/kb/v1/search?cb=searchCallback&requestId=54321&text=this%20is%20my%query&sameQ=false&sid=1001


URL Parameters

Key Example Value Description
auto true [Boolean] (Default is false) Indicates whether this request was automatically initiated, that is, not by user interaction
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
clientState positiveFeedback [String] (Default is none) Current client state: none (any), or positiveFeedback, or negativeFeedback, or chatAvailable, or chatUnavailable
expandEventsSupported false [Boolean] (Default is false) Indicates whether the widget/touch point/UI fully supports tracking of expand events to count their statistics more accurately
labelId 98765,56789 [String] The label Id(s) for the article(s) to find, separated by commas
requestId 54321 [String] Text you want returned in the response that is useful for detecting specific search requests
sameQ true [Boolean] (Default is false) Whether this query should be treated as a continuation of the previous query
searchInArticleBody true [Boolean] (Default is false) Whether to include the article body content in the search
sid 12345 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
src FAQ (REQUIRED) [String] Tracking Category: Used for Analytics. See the description of Interface Source at the top of the REST API & SDK Reference doc page.
suggestion false [Boolean] (Default is false) Indicates search result was selected from auto-complete suggestions
text article (REQUIRED) [String] The search query
translation [String] The translated search text
translationLanguage [String] The detected language of the text

INTERNAL ONLY URL Parameters

Key Example Value Description
includeOfflline true [Boolean] (Default is false) Whether to return offline articles in the search results. Reuires an API KEY with KB:Read permission.
naive false [Boolean] (Defaut is false) Use naive keyword-search algorithm. Disables all NLP features.
searchIn true [String] (Default is Online) KB section to search: Online (standard), or Publishing (not yet published), or All (both). Reuires an API KEY with KB:Read permissi

Response | Code: 200

{
	"requestId": "54321",
	"context": {
		"v": 4,
		"values": [
			{
				"name": "Audience",
				"flags": 252,
				"id": -822035058,
				"allowedValues": "Internal,External",
				"valueType": "4",
				"valueMap": "[{\"range\": \"23.239.224.1,207.106.191.66,67.208.179.242,23.239.224.10,207.106.191.101,67.208.179.250,185.48.40.84,202.173.25.1,202.173.25.2,198.11.8.66,50.225.191.66,50.225.191.69,144.121.13.227,162.246.193.18,162.246.193.19,195.56.119.18,62.77.229.2,195.228.171.178,81.0.80.114,195.228.171.181,81.0.80.117,78.108.113.1,78.108.113.8,87.234.250.194,217.112.149.146,89.101.131.33,178.250.118.66,89.101.131.36,178.250.118.68,66.210.9.162,209.2.117.178,216.219.125.1,216.219.125.10,185.36.22.1,185.36.22.2,23.239.225.1,23.239.225.2,185.36.21.1,185.36.21.2,185.36.21.4,185.36.21.10,109.174.158.34,46.255.117.130,67.217.79.1,67.217.79.25,67.217.79.10,185.36.20.1,185.36.20.2,23.239.226.1,23.239.226.2,67.217.90.1,23.239.228.1,23.239.228.2,67.217.73.244,67.217.74.244,173.199.22.0,38.122.236.74,184.23.196.146,202.173.24.1,203.46.126.17,202.173.24.2,203.46.126.18,91.120.32.58,91.83.100.89\", \"value\": \"Internal\" }]"
			},
			{
				"name": "Country",
				"flags": 206,
				"id": -1224618209,
				"allowedValues": "US,aus,can,in,uk,us",
				"valueType": "2",
				"valueMap": ""
			},
			{
				"name": "id_run",
				"flags": 72,
				"id": -1209781259
			},
			{
				"name": "platform",
				"flags": 238,
				"id": -1178355409,
				"allowedValues": "ai,agent"
			},
			{
				"name": "offering",
				"flags": 238,
				"id": -1138329746,
				"allowedValues": "service/agent,service,agent"
			}
		],
		"order": [
			-822035058,
			-1224618209,
			-1209781259,
			-1178355409,
			-1138329746
		]
	},
	"contextSuggestionEnabled": true,
	"kbLanguageCode": "en",
	"detectedLanguage": "",
	"totalKeywords": 1,
	"unknownWords": 0,
	"analysis": "article,FIRSTNAME*",
	"answers": [
		{
			"id": "2494427541",
			"visibility": "767",
			"rechanneling": [
				{
					"name": "Bold360ai Ticket Escalation ",
					"description": "Email form to escalate to nanorep support (Bold360ai queue)",
					"channel": "1",
					"actionEsc": "0",
					"buttonText": "Open ticket",
					"contactForms": "1558183221",
					"ticketingInterface": null,
					"showInArticle": false,
					"ThankYouMessage": null,
					"channelRuleId": "88"
				}
			],
			"keywordsetId": "10232",
			"likes": 0,
			"attachmentUrls": [],
			"title": "What is Site Map XML?",
			"summary": "<h2>What is Site Map XML?</h2>\n<div class=\"main\">\n...</div>",
			"actions": "",
			"context": "-1178355409,ai,-1138329746,service,-1224618209,US"
		},
		{
			"id": "2494385851",
			"visibility": "767",
			"rechanneling": [
				{
					"name": "Bold360ai Ticket Escalation ",
					"description": "Email form to escalate to nanorep support (Bold360ai queue)",
					"channel": "1",
					"actionEsc": "0",
					"buttonText": "Open ticket",
					"contactForms": "1558183221",
					"ticketingInterface": null,
					"showInArticle": false,
					"ThankYouMessage": null,
					"channelRuleId": "88"
				}
			],
			"keywordsetId": "9926",
			"likes": 0,
			"attachmentUrls": [],
			"title": "How can I add a new article to my Knowledge Base?",
			"summary": "<h2>How can I add a new article to my Knowledge Base?</h2>\n<div class=\"main\">
...</div>",
			"actions": "",
			"context": "-1178355409,ai,-1138329746,service,-1224618209,US"
		}
	]
}
                  
Article - Get by Id (getArticle) https://{{account}}.{{domainName}}/api/kb/v1/getArticle

Description

Get a knowledge base Article by its Id with optional reporting (tracking). You must first call: 1) Session - Start (hello) to get a sid; and 2) Knowledge Bases - Get (getKBs) to get a KB. Updates analytics and the client state.

Version: 1

Required Permissions for API Key: Not applicable

HTTPS Only: False

Requires Session: True

Example: https://myAccount.myDomain.com/api/kb/v1/getArticle?Id=2195863691&kb=2071169051&sid=5129268061394679732


URL Parameters

Key Example Value Description
answerId 2654002601 (REQUIRED) [String] Article Id: The Id number shown on the page when editing an article (answer) in the Bold360 AI Console's Knowledgebase
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
clientState positiveFeedback [String] The new web client condition to be reflected in the conversational widget, if applicable: chatAvailable, chatUnavailable, negativeFeedback, none, or positiveFeedback
kbLC es [String] Knowledge base language code given by cnf.js, and from q.js request returned to server for use by the web client. For example: en, es, fr, and iw.
requestId myRequestId [String] Text you want returned in the response that is useful for detecting specific search requests
sid 1234567890123456789 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
src FAQ (REQUIRED) [String] Tracking Category: Used for Analytics. See the description of Interface Source at the top of the REST API & SDK Reference doc page.

Response | Code: 200

{
    "requestId": "myRequestId",
    "kbLanguageCode": "en",
    "answers": [
        {
            "id": "1654002601",
            "visibility": "755",
            "keywordsetId": "0",
            "likes": 0,
            "attachmentUrls": [],
            "title": "How do I get help?",
            "summary": "<p><strong>Simply type your question in the search box above to get instant answers.</strong><br /><br />Tips: For better results, type more than one word and use a question phrasing.<br />If you don&#39;t find a match try phrasing your question differently.</p>",
            "actions": ""
        }
    ]
}
                  
Article - Get by Loose Search (looseSearch) INTERNAL ONLY http://{{account}}.{{domainName}}/api/kb/v1/looseSearch

Description

Query the search engine for answers.

For more information regarding context, see What are Bold360 AI Contextual Answers?.


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
fields [String] Add selected fields to the export: contextMeta, or metaDescription, or metaTitle
hideOfflineArticles Hide the offline articles in the KB
index Which index to search in
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
maxResults A number indicating the max results. Use -1 for all results.
query Query: Text to search for in the knowledge base (URL encoded)
Article - Get by Simple Query (simpleSearch) http://{{account}}.{{domainName}}/api/kb/v1/simpleSearch

Description

Search for articles matching a query depending on a precision.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/kb/v1/simpleSearch?kb=KB_NAME&precision=normal&apiKey=ApiKey&query=QueryString&cb=CallbackFunction


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
bestContextualVariation true [Boolean] (Default is true) Get best contextual variation result (true) or not (false)
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
hideOfflineArticles [Boolean] (Default is true) Suppress offline articles from the search
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
labelId 12345,54321 [String] The label Id(s) for the article(s) to find, separated by commas
maxResults 3 [Number] Maximum answers to return
precision normal [String] (Default is normal) The degree to which the query matches: fullResults, loose, normal, restrictive, veryRestrictive
query sample Query: Text to search for in the knowledge base
referer http://referringDomain/referringPage.html (REQUIRED) [String] Page referer: The address of the existing, previous web page from which a link to the current web page was followed
searchInContent [Boolean] (Default is false) Search in the article content for matches if setup for this knowledge base (view)
visitorToken [String] Locally stored string that uniquely identifies a given visitor

Response | Code: 200

{"result":"success","data":[{"id":"2721536321","title":"A sample title","body":" 
<p>A sample article body</p>","attachments":""},{"id":"2715374891","title":"A sample title11:12","body":"
<p>A sample article body</p>\n","attachments":""},{"id":"2715374781","title":"A sample title11:11","body":"
<p>A sample article body</p>\n","attachments":""}]}
                  
Article Data - Get (getArticleData) http://{{account}}.{{domainName}}/api/kb/v1/getArticleData

Description

Search for an article by its Id and returns its title, body, attachments, and important data tracked in the Bold360 AI Console.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Version: 1

Required Permissions for API Key: None

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/kb/v1/getArticleData?cb=FunctionName&id=12345&kb=KbName&referer=RefererUrl


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
encoding UTF-16 [String] (Default is UTF-8) Encoding: UTF-8, UTF-16, or UTF-32
id 2715374781 (REQUIRED) [String] Article Id: The Id number shown on the page when editing an article (answer) in the Bold360 AI Console's Knowledgebase
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
lang iw [String] (Default is en) Language Code: ar (Arabic), de (German), en (English), es (Spanish), fr (French), it (Italian), iw (Hebrew), nl (Dutch), pl (Polish), Portuguese (pt), ru (Russian), or sv (Swedish)
preview true [Boolean] (Default is false) If true, will not count this article as chosen in the statistics or log traffic
referer referringURL/referringPage.html [String] Page referer: The address of the existing, previous web page from which a link to the current web page was followed
tracking direct [String] Tracking Category: Used for Analytics. See the description of Interface Source at the top of the REST API & SDK Reference doc page.

INTERNAL ONLY URL Parameters

Key Example Value Description
i Widget instance ID. are returned to help find the correct widget for which the result is intended
index Article index in the most popular list are returned to help find the correct article for which the result is intended

Response | Code: 200

{
    "title": "A sample title", //The article title
    "body": "A sample article body", //The article body
    "attachments": "",

    "attachmentUrls": [ //Comma-separated list of attached file URLs

        "https://ACCOUNT.DOMAIN/storage/nr1/kb/3B9EBFFD/62CBC64D/663E8ABD/1/sample.txt"
    ],
    "s3attachments": "https://ACCOUNT.DOMAIN/storage/nr1/kb/3B9EBFFD/62CBC64D/663E8ABD/1/sample.txt",
    "likesCount": 0,
    "titleAndBodyHash": -1805990902,
    "actions": {}
}
                  
Article Data - Get Full (getFullArticleData) https://{{account}}.{{domainName}}/api/kb/v1/getFullArticleData

Description

Get complete information about an article.

The time value in the response is in .NET milliseconds that is described at the top of the REST API & SDK Reference doc page.

Version: 1

Required Permissions for API Key: None

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/kb/v1/getFullArticleData?articleId=ArticleId&kb=KbName&apiKey=ApiKey


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED if username and pw are not specified) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
articleId 1657522191 (REQUIRED) [String] The Article Id
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword (REQUIRED if apiKey is not specified) [String] Your password: The password assigned to your username in the Bold360 AI Console. Required if you use the username.. Will be deprecated as of March 3, 2020.
username myUserName (REQUIRED if apiKey is not specified) [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.

INTERNAL ONLY URL Parameters

Key Example Value Description
getSimilarArticles true [Boolean] (Default is false) Get similar phrases

Response | Code: 200

{
    "id": "1657522191", //article id
    "locked": false, // if true, the article is being used by another user
    "lockedBy": "First Last", // this only appears if the article is locked and is the name of the user that locked the article 
    "writeProtected": false, // if true, the article is protected by a manager
    "title": "How do I get help?",
    "body": "<p><strong>Type your question in the search box above to get instant answers.</strong><br/>
<br/>
Tips: For better results, type more than one word and use a question phrasing.<br/>
If you don&#39;t find a match try phrasing your question differently.</p>
",
    "variations": {},y
    "phrasings": [
        {
            "autoComplete": true,
            "negativeSample": false,
            "text": "How do I get help?"
        }
    ],
    "context": [], // the article context
    "drafts": [],
    "metaDescription": "",
    "metaTitle": "",
    "canonicalUrl": "",
    "externalSourceInfo": "",
    "chatEscalationAction": 1,
    "visibility": 755,
    "hasLockedVariation": false,
    "likeCounters": "{}",
    "attachmentUrls": [],
    "actions": "{}",
    "notes": "",
    "revisions": [
        {
            "time": 637066810220660000, // .NET ticks (nanoseconds from 1/1/1)
            "userId": 0,
            "userName": "",
            "entryId": "4223dab8-0eb5-033e-0a62-758a6d727fc1", // Id of this specific revision
            "articleData": {
                "status": 0,
                "visibility": 767,
                "isChangedLockedByManager": false,
                "lockedByManager": false,
                "neverPublished": false
            },
            "missingData": false
        },
        {
            "time": 637124798270840000,
            "userId": 1419231771,
            "userName": "First2 Last2", // name of user who made the revision
            "entryId": "200521bc-0b52-09db-0673-3f748dc70826",
            "articleData": {
                "status": 0,
                "phrasings": [
                    {
                        "text": "How do I get help?",
                        "autoComplete": true,
                        "negativeSample": false,
                        "entitiesMeta": []
                    }
                ],
                "title": "How do I get help?",
                "body": "@@ -4,17 +4,24 @@
 %3cstrong%3e
-T
+Simply t
 ype your
@@ -96,16 +96,14 @@
 r /%3e
-%0a
 %3cbr /%3e
-%0a
 Tips
@@ -182,17 +182,16 @@
 g.%3cbr /%3e
-%0a
 If you d
@@ -259,5 +259,4 @@
 %3c/p%3e
-%0a
",
                "expirationAction": 0,
                "chatInviteContent": "",
                "visibility": 755,
                "metaDescription": "",
                "metaTitle": "",
                "canonicalUrl": "",
                "labels": [],
                "actions": "",
                "notes": "",
                "isChangedLockedByManager": true,
                "lockedByManager": false,
                "neverPublished": false,n                "incomingLinks": [{ // articles that connect to this article
                    "id": 12345678,
                    "title": "title of article linked to here"
                }],
                "outgoingLinks": [{ // articles that connect from this article
                    "id": 09876543,
                    "title": "title of article linked from here"
                }]
            },
            "missingData": false
        }
    ],
    "translatedArticles": {},
    "labels": [
        5555555555
    ]
}
                  
Articles - Export (export) https://{{account}}.{{domainName}}/api/kb/v1/export

Description

For more information regarding context, see What are Bold360 AI Contextual Answers?.

URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
articleId Export all info about a specific article. If you use this, other filter parameters are ignored.
byPopularity If you use true (recommended), the most popular articles will show up first in the search results
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
days Use to show the most popular answers given by the nanorep widget during the last x days. This parameter only works with byPopularity=true
download Trigger browser file download
format Format to export the articles
IncludeHiddenFaqItems include article that hide from FAQ (article visibility)
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
labelId Use to show answers from a specific label only. You can find this information in the nanorep console when editing a label.
maxItems How many items to fetch
modifiedSince Format: yyyy-MM-ddTHH:mm. If used, only articles modified since this date are included.
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
skip The place in the list from which to start fetching. eg. use skip=10 to start fetching the list from the 11th item
textFilter Use to show answers that contain a certain word or phrase (base64 encoded string)
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.

INTERNAL ONLY URL Parameters

Key Example Value Description
_includePhrasings_internal_ true [Boolean] (Default is false) Include phrasings. Being deprecated. Depending on your release level, you might need to use _withPhrasings_ instead.
_phrasingsKind_internal_ entities [Boolean] (Default is false) How will the phrasings be formatted. If set, overrides _includePhrasings_internal_. Being deprecated. Depending on your release level, you might need to use _phrasingsKind_ instead.
phrasingsKind entities [String] How to format phrasings: none, or text, or entities (JSON). Supercedes _phrasingsKind_internal_ depending on your release level.
withContextConfig true Boolean] (Default is false) Include KB context config in the response. Pertains only to JSON.
withPhrasings true [Boolean] (Default is false) Include phrasings. Supercedes _includePhrasings_ depending on your release level.
withProviders true [Boolean] (Default is false) Include KB providers (entities) in the response. Pertains only to JSON.
withSynonyms true [Boolean] (Default is false) Include KB synonyms in the response. Pertains only to JSON.
Context & Form Values - Set (setParams) http://{{account}}.{{domainName}}/api/widget/v1/setParams

Description

Set Context and/or Form Values for subsequent searches in the current session.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Required Permissions for API Key: None

Requires Session: True

Example: http://ACCOUNT.nanorep.co/api/widget/v1/setParams?cb=callback&context=CONTEXT&sid:8760884429107438378&values=email_address:my@email.com


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
values [Base64 String] Key value pair for the contact form field in format: key:value, key:value. See the description of base64 at the top of the REST API & SDK Reference doc page.
Context Preset Values - Get (contextPresetValues) http://{{account}}.{{domainName}}/api/kb/v1/contextPresetValues

Description

Get the context preset values. For more information regarding context, see What are Bold360 AI Contextual Answers?.

Required Permissions for API Key: KB:Read

Example: http://ACCOUNT.nanorep.co/api/kb/v1/contextPresetValues?account=ACCOUNT&kb=KBNAME&referer=REFERERURL&contextName=Product&apiKey=API_KEY


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
contextName The name of the context that we want to get the preset values. If empty, return all the context of the KB.
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Context Values - Get (contextValues) http://{{account}}.{{domainName}}/api/kb/v1/contextValues

Description

Get the allowed context values. For more information regarding context, see What are Bold360 AI Contextual Answers?.

Required Permissions for API Key: KB:Read

Example: http://ACCOUNT.nanorep.co/api/kb/v1/contextValues?cb=FUNCTION&account=ACCOUNT&sid=4659575656682157842&maxOutputRows=2000&kb=KB_NAME&includeOffline=true&contexts=Accoun


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
contextId Context ID for which to return values
contexts List of contexts to return values for, in hierarchy order, use pipe ( | ) to get multiple context hierarchies (e.g., contexts=brand,model|usertype)
filter Filter values for the specified contextId to search for relevant values in hierarchy. Filter Format: contextName:contextValue,contextName:contextValue.Example value: brand:apple,deviceType:tablet - will return only values for which the brand and type are apple AND tablet.
format Add 'format:json' to receive response in pure JSON format without 'contextValuesHandler(...)' wrapper
includeOffine Controls access to offline context values
maxOutputRows Limits output rows.
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
FAQ Articles - Search (faq) http://{{account}}.{{domainName}}/api/kb/v1/faq

Description

Get the FAQ articles from the knowledge base according to the specified parameters.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/kb/v1/faq?cb=FunctionName&i=1&account=Account&days=10&items=10&kb=KbName


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
allContextMandatory true [Boolean] (Default is false) Whether only context answers are returned: true (they are), false (generic answers are also returned)
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context ZGV2aWNlVHlwZTpBbmRyb2lk (REQUIRED if either requiredContext or requiredContextId is specified) [Base64 String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,.... See the description of base64 at the top of the REST API & SDK Reference doc page.
days 3 [Number] (Default is 0, today) The number of days of statistics to return
encoding utf-16 [String] The encoding name to use for the returned result, not applicable to all languages or knowledge bases
generic false [Boolean] (Default is false) Whether only generic answers (answers with no context values) are returned (true), or answers with context values are also returned (false)
i 999 [Number] (Default is 0) Widget instance ID: Returned to help identify the correct widget for which the results are intended
items 3 (REQUIRED) [Number] The maximum number of items to fetch in the faq list
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
labelId A1C93853 [String] The label Id, in hexadecimal, for the article to return
lang en [String] Language Code: ar (Arabic), de (German), en (English), es (Spanish), fr (French), it (Italian), iw (Hebrew), nl (Dutch), pl (Polish), Portuguese (pt), ru (Russian), or sv (Swedish). Used when auto-translation is enabled.
noFilter false [Boolean] (Default is true) True to include results without hits, false not to include them
query eW91ciBzdHJpbmc= [Base64 String] Query: Text to search for in the knowledge base. See the description of base64 at the top of the REST API & SDK Reference doc page.
requiredContext deviceType [String] Only articles with this context will be returned
requiredContextId -12345 [Number] Only articles with this context will be returned

Response | Code: 200

{
    "instanceId": 999, //This is the i parameter
    "cacheVar": 637160726240207697, //Server dateTime ticks (see time at the top of the reference documentation page)
    "lang": "en",
    "supportCenterDomain": "",
    "mainSiteURL": "",
    "data": [
        {
            "id": 0,
            "data": [
                {
                    "label": "Are you looking for help about another LogMeIn product?", //Article title
                    "data": 0,//The number of times the article was chosen as an answer
                    "objectId": "1559666131", //Article ID
                    "count": 0,
                    "percent": 0,//Percent of the queries for the KB that have been answered by this article
                    "likes": 0, //The number of likes this article has received
                    "titleAndBodyHash": 214773646,
                    "visibility": 767
                },
                {
                    "label": "Account and billing inquiries",
                    "data": 0,
                    "objectId": "1729440191",
                    "count": 0,
                    "percent": 0,
                    "likes": 0,
                    "titleAndBodyHash": -777352664,
                    "visibility": 767
                },
                {
                    "label": "How can I generate my own reports in Bold360 ai?",
                    "data": 0,
                    "objectId": "1494408561",
                    "count": 0,
                    "percent": 0,
                    "likes": 1,
                    "titleAndBodyHash": -727297389,
                    "visibility": 767
                }
            ]
        }
    ],
    "integrate_ga": true //Google Analytics integration for this account
}
                  
FAQ Articles Data - Get (faqs) http://{{account}}.{{domainName}}/api/widget/v1/faqs

Description

Get the FAQ Article data. Optionally filter by referer using the configId.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Required Permissions for API Key: None

Example: http://ACCOUNT.nanorep.co/api/widget/v1/faqs?referer=REFERER&account=ACCOUNT&context=Q2hhbm5lbDpkZXNrdG9w


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
configId myConfigId [String] Config Id: The Domain API ID value shown in the Bold360 AI Console: TOUCHPOINTS > Widgets, choose your widget type, and select the Advanced tab
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
encoding Request encoding
translationLanguage Response language
widgetType float [String] Either embed, float, or advise
Feedback - Mask User (maskUserFeedbackText) INTERNAL ONLY https://{{account}}.{{domainName}}/api/events/v1/maskUserFeedbackText

Description

Mask the user feedback from events whose Ids are specified in the reports. Can be used for GDPR.

Required Permissions for API Key: Voices:Write

HTTPS Only: True

https://ACCOUNT.nanorep.co/api/events/v1/maskUserQuery?eventIds=6542866,42894863,42864286&apiKey=APIKEY


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
eventIds Comma separated event ids to mask the user feedback text from.
Query - Auto-complete (autoComplete) http://{{account}}.{{domainName}}/api/kb/v1/autoComplete

Description

Suggest query completions while the user is typing a search query. The suggestions are sorted by popularity, and the strong words are marked in the response.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Version: 1

Required Permissions for API Key: None

HTTPS Only: False

Requires Session: True

Example: http://ACCOUNT.nanorep.co/api/kb/v1/autoComplete?cb=callback&text=how%20muc&requestId=54321&sid=8458330290704559761


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context ZGV2aWNlVHlwZTpBbmRyb2lk [Base64 String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,.... Specifies the context values of the articles to return. See the description of base64 at the top of the REST API & SDK Reference doc page.
labelId 2714318931 [String] Filter articles that have ALL specified label(s). Separate multiple labels by a comma, such as 1,2,3.
maxResults 3 [Number] Maximum number of results to return
requestId 54321 [String] Text you want returned in the response that is useful for detecting specific search requests
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
text escalate (REQUIRED) [String] The search query
verbose true [Boolean] (Default is false) Include article Ids in the response

Response | Code: 200

{
    "c": 3,
    "rid": "54321",
    "lc": "en",
    "q": "escalate,FIRSTNAME",
    "a": [
        "how|to|assign*|a|label*|for|a|ticket*|escalated,escalate*|from|a|certain*|page*",
        "how|can|i|retrieve*|the|list*|of|emails,email*|of|users,user*|who*|escalated,escalate*",
        "escalate*|to|chat*"
    ]
}
                  
Query - Conversational Auto-complete (autoComplete) http://{{account}}.{{domainName}}/api/conversation/v1/autoComplete

Description

Suggest query completion to the user. Used while user is typing a search query. When a conversation is tied to an entity, the suggestion will be based on the possible result. Otherwise, the suggestions are taken from the knowledge base and are sorted by popularity. It marks the strong words in the response.

Required Permissions for API Key: None

Example: http://ACCOUNT.nanorep.co/api/conversation/v1/autoComplete?id=5468230905248276759&text=b&cb=method&maxResults=5


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
id [String] The conversation Id from the Conversation - Create (create) response, in the case of a conversation event
maxResults Max result
text User query
verbose If set to true - the response contains the modified article Ids
Query - Conversational Auto-complete v2 (autoComplete) http://{{account}}.{{domainName}}/api/conversation/v2/autoComplete

Description

Suggest query completion to the user. Used while user is typing a search query. When a conversation is tied to an entity, the suggestion will be based on the possible result. Otherwise, the suggestions are taken from the knowledge base and are sorted by popularity. It marks the strong words in the response. The response returns the ORIGINAL phrase/entity (including uppercase letters, punctuations, etc.).

Required Permissions for API Key: None

Example: http://ACCOUNT.nanorep.co/api/conversation/v1/autoComplete?id=5468230905248276759&text=b&cb=method&maxResults=5


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
id [String] The conversation Id from the Conversation - Create (create) response, in the case of a conversation event
maxResults Max result
text User query
verbose If set to true - the response contains the modified article Ids
Query - Mask User (maskUserQuery) INTERNAL ONLY https://{{account}}.{{domainName}}/api/events/v1/maskUserQuery

Description

Mask the user query from events and voices data by events Ids specified in the reports. Can be used for GDPR.

Required Permissions for API Key: Voices:Write

HTTPS Only: True

https://ACCOUNT.nanorep.co/api/events/v1/maskUserQuery?eventIds=6542866,42894863,42864286&apiKey=APIKEY


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
eventIds Comma separated event ids to mask the user query from.

Channels

The Channels REST API calls perform operations regarding communication mechanisms that Bold360 AI provides so you can directly communicate with your users. The administrator oversees the channels in the Bold360 AI Console.
Channels - Get (get) http://{{account}}.{{domainName}}/api/channeling/v1/get

Description

Get all channels.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Required Permissions for API Key: None

Example: http://ACCOUNT.nanorep.co/api/channeling/v1/get?referer=REFERER&account=ACCOUNT&kb=KB_NAME


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
articleId The article that we want the channels for.
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
clientState System.Object[] Current client state (Flag)
configId
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
referer referringURL/referringPage.html (REQUIRED) [String] Page referer: The address of the existing, previous web page from which a link to the current web page was followed
text The query text
Chat Escalation - Rechannel (escalate) http://{{account}}.{{domainName}}/api/channeling/v1/escalate

Description

Rechannel (escalate) a chat query (email, chat, contact form etc.) to an agent

Required Permissions for API Key: None

Requires Session: True

Example: http://ACCOUNT.nanorep.co/api/channeling/v1/escalate?cb=callback&type=0&text=how%20much%20does%20it%20costs&articleId=1031996&translationLanguage=en&sid=284330783507206996


URL Parameters

Key Example Value Description
apiName The api that do the escalation
articleId Escalated article id
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
chatType The type of the chat that we escalate from
contactForm Submitted contact form info. In base64 format which ‘=’ was replaced with ‘_’ and ‘+’ was replaced with ‘|’
contactFormId The type of the contact form ID that we escalate from
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
text The search query received the result.
translationLanguage Query’s language code
type Escalation type.
widgetType Widget type

INTERNAL ONLY URL Parameters

Key Example Value Description
sentiment [String] The channel's sentiment (positive, neutral or negative). Used only if Intentional channeling feature is enabled for the account.
Chat Escalation - Report (report) http://{{account}}.{{domainName}}/api/channeling/v1/report

Description

For more information regarding context, see What are Bold360 AI Contextual Answers?.

URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiName The apiName of the channel
articleId The article that connect to the escalation. if there is no article- don't sent this paramater.
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
chatEscalationAction [Number] (Default is 0) The chat Escalation type (if the escalation type is email- must be hide!)
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...

INTERNAL ONLY URL Parameters

Key Example Value Description
sentiment [String] The channel's sentiment (positive, neutral or negative). Used only if Intentional channeling feature is enabled for the account.
Form - Get (getForm) http://{{account}}.{{domainName}}/api/channeling/v1/getForm

Description


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
contactFormId
sid

Conversations

The Conversations REST API calls manage live chat messaging in Bold360 AI.

Note that knowledge base articles must be published and online to use them as responses to user input. Sophisticated natural language algorithms match user entry to the article Phrasings.

Conversations use lists to drive the user exchange. Entities and providers decide how the conversations use the lists. Entities identify article objects, such as [[BALANCE_TYPE]], and choose the most logical order of the questions in the list. Entities are plain key-value objects where the key is the entity name and the value is data or functions that return entity data. Providers steer the conversation based on a pre-defined set of questions in the list.

For more information, see Conversational mode under the Widget Events topic in the Web API & SDK Reference and the What is the difference between Entities and CSV Providers? article in the support help.

Chat Statement - Get (reportChatStatement) INTERNAL ONLY https://{{account}}.{{domainName}}/api/voices/v1/reportChatStatement

Description

Get a chat statement for the Live Agent Dashboard.

Version: 1

Required Permissions for API Key: KB:ReadVoices:Write

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/voices/v1/reportChatStatement?kb=KBNAME&apiKey=APIKEY&statement=STATEMENT


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
query Query: Text to search for in the knowledge base
Conversation - Create (create) http://{{account}}.{{domainName}}/api/conversation/v2/create

Description

Start a new conversation, and get its Conversation Id.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Version: 2

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.com/api/conversation/v2/create?apiKey=ApiKey&kb=KbId


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
domainId 2000259671 [Number] The ID of the domain that triggered the conversation, if any. This can be found from the id field in the Widget Configuration - Get (cnf) response.
entities entity1:value1,entity2:value2,...,entityN:valueN [String] Entities Data: Comma-separated list of key:value pair(s) representing conversation entities data
firstName John [String] User's first name
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
lastName Doe [String] User's last name
locale en_US [String] User's locale (de_DE, en_US, fr_CA, etc.)
supportedEntities CustomEntity1 [String] Comma-separated list of entities supported by the hosted application
timezone -5 [Number] The user's timezone hour(s) difference from UTC used for date/time calculations
touchpoint MyTouchpoint The Conversation touchpoint to use in the statement call
visitorToken 12345 [Number] Locally stored visitor token to uniquely identify a given visitor in the response

INTERNAL ONLY URL Parameters

Key Example Value Description
disableStatistics true [Boolean] (Default is false) Whether to stop gathering conversation statistics. Cannot be false if includeDraftsAndOffline is true.
enableLog false [Boolean] (Default is true) Whether to write to the conversation log
includeDraftsAndOffline true [Boolean] (Default is false) Whether to include both Drafts and Offline
textOnly false [Boolean] (Default is true) Whether to deliver the conversation as text (true) or HTML (false)

Response | Code: 200

{
    "id": "8976427398460955981", //Conversation Id
    "lang": "en", //Language
    "kb": "MyKb", //Knowledge base name
    "kbId": 992705342, //Knowledge base Id
    "visitorToken": "6714540232128897457" //User Id
}
                  
Conversation Context - Update (setContext) http://{{account}}.{{domainName}}/api/conversation/v1/setContext

Description

Update the context of a conversation. The specified context categories override any existing context category values. For more information regarding context, see What are Bold360 AI Contextual Answers?.

Required Permissions for API Key: KB:Read

Example: http://SERVER.nanorep.com/api/conversation/v1/setContext?id=CONVERSATIONID&context=cat1:val1,cat2:val2


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context deviceType:Android (REQUIRED) [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
id (REQUIRED) [String] The conversation Id from the Conversation - Create (create) response
Conversation Statements - Get (statement) http://{{account}}.{{domainName}}/api/conversation/v1/statement

Description

Get statements of matching questions, answers, and more supporting data for a conversation.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://myAccount.myDomain.com/api/conversation/v1/statement?id=ConversationId&statement=myStatement


URL Parameters

Key Example Value Description
articleId 2721536321 [String] Article Id: The Id number shown on the page when editing an article (answer) in the Bold360 AI Console's Knowledgebase
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
entities External entities
id 4489333403546173527 (REQUIRED) [String] The conversation Id from the Conversation - Create (create) response
queryLanguageCode es [String] Two-lettered language code. This can be found from the translationLanguages field in the Widget Configuration - Get (cnf) response.
src MySrc [String] Tracking Category: Used for Analytics. See the description of Interface Source at the top of the REST API & SDK Reference doc page.
statement help (REQUIRED) [String] User statement/query

Response | Code: 200

{
    "entities": {
        "1": {
            "kind": "$USER",
            "value": "John", //From the conversation creation
            "type": "text",
            "matchedToken": "",
            "entityLifecycle": "persistent",
            "confidence": 1,
            "public": true,
            "statementId": 0,
            "tokenModifier": "none",
            "tokenRangeSet": false,
            "tokenRangeStart": -1,
            "tokenRangeEnd": -1,
            "properties": [
                {
                    "name": "FIRSTNAME",
                    "kind": "FIRSTNAME",
                    "value": "John", //From the conversation creation
                    "type": "text"
                },
                {
                    "name": "LASTNAME",
                    "kind": "LASTNAME",
                    "value": "Doe", //From the conversation creation
                    "type": "text"
                },
                {
                    "name": "TIMEZONE",
                    "kind": "TIMEZONE",
                    "value": "-5", //From the conversation creation
                    "type": "number"
                },
                {
                    "name": "LOCALE",
                    "kind": "LOCALE",
                    "value": "en_US", //From the conversation creation
                    "type": "text"
                }
            ]
        },
        "2": {
            "kind": "$TOUCHPOINT",
            "value": "API",
            "type": "text",
            "matchedToken": "",
            "entityLifecycle": "persistent",
            "confidence": 1,
            "public": true,
            "statementId": 0,
            "tokenModifier": "none",
            "tokenRangeSet": false,
            "tokenRangeStart": -1,
            "tokenRangeEnd": -1
        }
    },
    "text": "Simply type your question in the search box above to get instant answers.\r\n\r\nTips: For better results, type more than one word and use a question phrasing.\r\nIf you don't find a match try phrasing your question differently.\r\n",
    "responseType": "normal",
    "quickOptions": [],
    "persistentOptions": [
        {
            "text": "Open in browser",
            "type": "url",
            "url": "https://subdomain.domain/widget/widget.html#account=MyAccount&kb=232707992&referer=&onloadquestionid=832708472",
            "kind": "supportCenterLink"
        }
    ],
    "articleId": "832708472",
    "articleMeta": {
        "attachmentUrls": [],
        "visibility": "755"
    },
    "statement": "help ",
    "userQuery": "help"
}
                  
Entities - Get (getEntities) INTERNAL ONLY http://{{account}}.{{domainName}}/api/conversation/v1/getEntities

Description

Get the entities for a conversation Id.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.co/api/conversation/v1/getEntities?id=CONVERSATIONID


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
id The conversation id.
Entities Manifest - Get (getEntitiesManifest) https://{{account}}.{{domainName}}/api/conversation/v1/getEntitiesManifest

Description

Get the knowledge base's entity manifest.

HTTPS Only

Required Permissions for API Key: KB:Read

Example: https://SERVER.nanorep.com/api/conversation/v1/getEntitiesManifest?kb=KBNAME&apiKey=APIKEY


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
Feedback Response - Create (createFeedbackResponse) INTERNAL ONLY http://{{account}}.{{domainName}}/api/conversation/v1/createFeedbackResponse

Description

Create a feedback response for a conversation Id.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.com/api/conversation/v1/createFeedbackResponse?id=CONVERSATIONID


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
id (REQUIRED) The conversation Id
queryLanguageCode Language code: Any of the supported language codes as returned in the translationSupportedLanguages field in the cnf API call

Response | Code: 200

{
	"text": "this is the answer",	"answersCaption": "this is the answer in case of multiple answers",
	"entities": {
		"$USER": ""
	},
	"quickOptions": [{
		"text": "option text",
		"type": "postback", // postback|location
		"postback": "POSTBACK" // only when type is postback
		"kind": "option kind" // askAnAgent|supportCenterLink|channel| readMore|userOption|feedback|location
	}, {...	}, {}],
	"persistentOptions": [{
		"text": "option string",
		"data": "option data",
		"type":"url" // url|postback,
		"postback": "POSTBACK" // only in postback type,
		"url": "url.com" // only in url type
		"kind": "option kind" // askAnAgent|supportCenterLink|channel|readMore|userOption|feedback|location|answer
	},{..}],
	"articleId": 123,
	"query": "user query"
}
                  
Provider - Get (getProvider) INTERNAL ONLY https://{{account}}.{{domainName}}/api/conversation/v1/getProvider

Description

Get provider data by Id.

HTTPS Only: True

https://SERVER.nanorep.co/api/conversation/v1/getProvider?kb=KB&apiKey=APIKEY&id=PROVIDERID


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Provider - Remove (removeProvider) https://{{account}}.{{domainName}}/api/conversation/v1/removeProvider

Description

Remove a Provider from the knowledge base.

HTTPS Only

Required Permissions for API Key: KB:Write

Example: https://SERVER.nanorep.co/api/conversation/v1/removeProvider?kb=KB&apiKey=APIKEY&id=PROVIDERID


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
id The provider's unique id.
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
Provider - Set (setProvider) INTERNAL ONLY https://{{account}}.{{domainName}}/api/conversation/v1/setProvider

Description

Update existing or create a new conversation provider.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: False

Example: https://SERVER.nanorep.co/api/conversation/v1/setProvider?kb=KB&apiKey=ApiKey

In Postman, the Request Body works as raw, Text. Others might work, too.

Request Body

{
    "type": "Webhook", //Webhook|csv
    "isActive": true,
    "name": "currency", //providerName
    "options": "PROVIDER_DATA"
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Provider Articles - Get (getLinkedArticlesToProvider) https://{{account}}.{{domainName}}/api/kb/v1/getLinkedArticlesToProvider

Description

Get the list of articles linked to a provider.

HTTPS Only

Required Permissions for API Key: KB:Write

Example: https://SERVER.nanorep.co/api/kb/v1/getLinkedArticlesToProvider?kb=KB&apiKey=APIKEY&providerId=PROVIDERID


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
providerId The provider's unique Id.
Provider Code - Get (getProviderCode) INTERNAL ONLY http://{{account}}.{{domainName}}/api/conversation/v1/getProviderCode

Description

Get the Inline provider code for a JavaScript function.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.com/api/conversation/v1/getProviderCode?kb=KB&apiKey=APIKEY&functionName=FUNCTIONNAME


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
functionName FunctionName The function name.
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
version The function version.
Provider Code - Set (createUpdateInlineCodeProvider) INTERNAL ONLY http://{{account}}.{{domainName}}/api/conversation/v1/createUpdateInlineCodeProvider

Description

Create a new inline code function or update an existing function.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.com/api/conversation/v1/createUpdateInlineCodeProvider?kb=KB&apiKey=ApiKey&providerName=ProviderName

In Postman, the Request Body works as raw, Text. Others might work, too.

Request Body

{
    "v": 0, //nanorep library version
    "functionName": "NAME",
    "status": "publish", //publish|save
    "code": "CODE"
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
description Function description.
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
providerName The provider name that the function belone to.
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Provider Code - Test (testInlineProvider) https://{{account}}.{{domainName}}/api/conversation/v1/testInlineProvider

Description

Test an inline function.

HTTPS Only

Required Permissions for API Key: KB:Write

Example: https://SERVER.nanorep.com/api/conversation/v1/testInlineProvider?kb=KB&apiKey=APIKEY&providerName=PROVIDERNAME&functionName=FUNCTION_NAME

Request Body

{
    "functionName": "NAME",
    "version": 0, // inline verssion to test ($LATEST by default)
    "requestBody":"function request body"
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
providerName (REQUIRED) [String] The provider name that the function belone to.
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Providers - Get (getProviders) INTERNAL ONLY http://{{account}}.{{domainName}}/api/conversation/v1/getProviders

Description

Get all the external providers that the conversation engine work with for this account.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.com/api/conversation/v1/getProviders?kb=KB&apiKey=API_KEY


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Providers - Set (setProviders) INTERNAL ONLY http://{{account}}.{{domainName}}/api/conversation/v1/setProviders

Description

Update existing conversation providers.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.co/api/conversation/v1/setProviders?kb=KB&apiKey=ApiKey

In Postman, the Request Body works as raw, Text. Others might work, too.

Request Body

{
    "type": "Webhook", //Webhook|csv
    "isActive": true,
    "name": "currency", //providerName
    "options": "PROVIDER_DATA"
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Providers Analytics - Get (getProvidersAnalytics) INTERNAL ONLY https://{{account}}.{{domainName}}/api/conversation/v1/getProvidersAnalytics

Description

Get the list of providers for all the accounts in the server (for admins only).

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: False

Example: https://SERVER.nanorep.co/api/conversation/v1/getProvidersAnalytics?apiKey=ApiKey


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).

Cookies

The Cookies REST API calls read and update cookies that Bold360 AI uses for Reports & Analytics by web widgets.
Cookie - Validate (validatecookie) INTERNAL ONLY http://{{account}}.{{domainName}}/api/widget/v1/validatecookie

Description

Validate user Cookie in the header

Cookies - Clear (clearCookies) https://{{account}}.{{domainName}}/api/cookies/v1/clearCookies

Description

Clear cookies from the account domain. The allowed cookie names are restricted and updating from time to time. In the time of writing this, the only allowed cookie names are "guideState" and "waitForRedirect".

HTTPS Only

Required Permissions for API Key: None

Example: https://ACCOUNT.nanorep.co/api/cookies/v1/clearCookies?cb=callback&guideState=


URL Parameters

Key Example Value Description
[cookieName] you should replace [cookieName] with the desired cookie name and MUST add = in the end.
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
Cookies - Get (getCookies) https://{{account}}.{{domainName}}/api/cookies/v1/getCookies

Description

Get cookies from the account domain. The allowed cookie names are restricted and updating from time to time. In the time of writing this, the only allowed cookie names are "guideState" and "waitForRedirect".

HTTPS Only

Required Permissions for API Key: None

Example: https://ACCOUNT.nanorep.co/api/cookies/v1/getCookies?cb=callback&guideState=


URL Parameters

Key Example Value Description
[cookieName] you should replace [cookieName] with the desired cookie name and MUST add = in the end.
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
Cookies - Prepare Domain Change (prepareCookiesForDomainSwitching) INTERNAL ONLY http://{{account}}.{{domainName}}/console/prepareCookiesForDomainSwitching

Description

Gather cookie information needed before switching a domain. Execute this before Cookies - Remake Domain Change (remakeCookiesForDomainSwitching).


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
gotoURL the url (including the domain name) that should be opened after the switch
Cookies - Remake Domain Change (remakeCookiesForDomainSwitching) INTERNAL ONLY https://{{account}}.{{domainName}}/console/remakeCookiesForDomainSwitching

Description

Remake the cookies from information gathered by calling Cookies - Prepare Domain Change (prepareCookiesForDomainSwitching)


URL Parameters

Key Example Value Description
gotoURL the url (including the domain name) that should be opened
initcode the session code for the current user
nanouserauth the cookie value for NanoUserAuth
Cookies - Set (setCookies) https://{{account}}.{{domainName}}/api/cookies/v1/setCookies

Description

Set cookies on the account domain. The allowed cookie names are restricted and updating from time to time. In the time of writing this, the only allowed cookie names are "guideState" and "waitForRedirect".

HTTPS Only

Required Permissions for API Key: None

Example: https://ACCOUNT.nanorep.co/api/cookies/v1/setCookies?cb=callback&guideState=123&waitForRedirect=456


URL Parameters

Key Example Value Description
[cookieName] you should replace [cookieName] with the desired cookie name. The value is the desired value you want to set to this cookie.
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call

Knowledge Bases

The Knowledge Bases REST API calls control the Bold360 AI knowledge bases.
Context Config - Get (getContextConfig) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/v1/getContextConfig

Description

Get KB context configuration to a JSON message or file.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/kb/v1/getContextConfig?kb=KbName&apiKey=ApiKey


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
download true [Boolean] (Default is false) Trigger browser file download
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
password myPassword [String] Your password: The password assigned to your username in the Bold360 AI Console. Required if you use the username.. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Context Config - Set (setContextConfig) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/v1/setContextConfig

Description

Import context configuration into the knowledge base from JSON. Once this successfully completes, the contexts should appear in the Bold360 AI Console's KB Setup.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/kb/v1/setContextConfig?kb=KbName&apiKey=ApiKey

In Postman, the Request Body works as raw, Text. Others might work, too.

Request Body

{
    "v": 4,
    "values": [
        {
            "name": "usertype",
            "flags": 255,
            "id": -1707677501,
            "allowedValues": "normal,vip",
            "lifeCycle":"persistent"
        },
        {
            "name": "Cars",
            "flags": 247,
            "id": -922091725,
            "selectionText": "Please select a context:",
            "allowedValues": "BMW,SUBARU,MAZDA,HYUNDAI",
            "lifeCycle": "persistent"
        },
        {
            "name": "Country_1",
            "flags": 239,
            "id": -1224618209,
            "selectionText": "Please select Country:",
            "allowedValues": "Israel,Spain",
            "valueType": "4",
            "valueMap":"[{\"range\":\"1.1.1.1-10.10.10.10\",\"value\":\"Japan\"},{\"range\":\"11.11.11.11-101.101.101.101\",\"value\":\"India\"}]",
            "lifeCycle":"topic"
        },
        {
            "name": "Country_2",
            "flags": 239,
            "id": -1224618210,
            "selectionText": "Please select Country:",
            "allowedValues": "Italy",
            "valueType": "5",
            "valueMap":"[{\"range\":\"1.1.1.1-10.10.10.10\",\"value\":\"Japan\"},{\"range\":\"11.11.11.11-101.101.101.101\",\"value\":\"India\"}]",
            "lifeCycle":"topic"
        }
    ],
            "name": "deviceType",
            "flags": 255,
            "id": -1224618211,
            "allowedValues": "iOS,Android",
            "lifeCycle":"persistent"
        },
    "order": [
        -1707677501,
        -922091725,
        -1224618209,
        -1224618210,
        -1224618211
    ]
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

(empty)
                  
Knowledge Base - Create (create) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/v1/create

Description

Create a new knowledge base.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: False

Example: https://myAccount.myDomain.co/api/kb/v1/create?apiKey=myApiKey&lang=en&name=myKbName

Alias URLs: None


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED if username and pw are not specified) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
lang en (REQUIRED) [String] Language Code: ar (Arabic), de (German), en (English), es (Spanish), fr (French), it (Italian), iw (Hebrew), nl (Dutch), pl (Polish), Portuguese (pt), ru (Russian), or sv (Swedish)
name myKbName (REQUIRED) [String] The name of the new KB.
pw myPassword (REQUIRED if apiKey is not specified) [String] Your password: The password assigned to your username in the Bold360 AI Console. Required if you use the username.. Will be deprecated as of March 3, 2020.
username myUserName (REQUIRED if apiKey is not specified) [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.

Response | Code: 200

{
    "status": "success"
}
                  
Knowledge Base - Update (updateSettings) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/v1/updateSettings

Description

Update the knowledge base configuration.

Version: 1

Required Permissions for API Key: Highest:Write

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.DOMAIN/api/kb/v1/updateSettings?apiKey=myApiKey&kb=MyKB&key=ConversationEnabled&value=True


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} (REQUIRED if username and pw are not specified) [String} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB (REQUIRED) Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
key ConversationEnabled (REQUIRED) Account Status: ConversationEnabled
pw myPassword (REQUIRED if apiKey is not specified) [String} Password. Will be deprecated as of March 3, 2020.
username myUserName (REQUIRED if apiKey is not specified) [String} User Name. Will be deprecated as of March 3, 2020.
value False (REQUIRED) The new value
Knowledge Bases - Get (getKBs) https://{{account}}.{{domainName}}/api/accounts/v1/getKBs

Description

Get the list of knowledge bases for an account.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: True

Requires Session: False

Example: https://myAccount.myDomain.com/api/accounts/v1/getKBs?account=myAccount&apiKey=myApiKey


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.

Response | Code: 200

{
  "KBs":[
    {
      "Id":2000259841,
      "Name":"kbName1"
    },
    {
      "Id":2004334091,
      "Name":"kbName2"
    },
    {
      "Id":2039744751,
      "Name":"kbName3"
  
    }
  ]
}
                  
Synonyms - Get (getSynonyms) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/v1/getSynonyms

Description

Get the KB synonyms to a text message or file, each separated by a pipe (|) symbol.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/kb/v1/getSynonyms?kb=KbName&apiKey=ApiKey


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} [String} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
download true [Boolean] (Default is false) Trigger browser file download
kb myKB (REQUIRED) Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String} Password. Will be deprecated as of March 3, 2020.
username myUserName [String} User Name. Will be deprecated as of March 3, 2020.
Synonyms - Set (setSynonyms) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/v1/setSynonyms

Description

Import synonyms into the KB by a text message or file, each separated by a pipe (|) symbol.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: False

Example: https://ACCOUNT.nanorep.co/api/kb/v1/setSynonyms?kb=KbName&apiKey=ApiKey

We are assuming the Request Body works as raw, Text in Postman.

Request Body

acquire|buy|pay|purchase
do|operate|work
cost|fee|price

URL Parameters

Key Example Value Description
account myAccount (REQUIRED) Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey
kb myKB (REQUIRED) Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String} Password. Will be deprecated as of March 3, 2020.
username myUserName [String} User Name. Will be deprecated as of March 3, 2020.
Voice - Assign (assignVoice) INTERNAL ONLY http://{{account}}.{{domainName}}/api/voices/v1/assignVoice

Description

Assign a user to a voice


URL Parameters

Key Example Value Description
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
userId The user Id
voiceId The voice Id
Voice - Unsassign (unassignVoice) INTERNAL ONLY http://{{account}}.{{domainName}}/api/voices/v1/unassignVoice

Description

Unassign a user from a voice


URL Parameters

Key Example Value Description
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
userId The user Id
voiceId The voice Id

Labels

The Labels REST API calls manage the article categories in the Bold360 AI Console. Labels enable you to search, categorize, and identify articles for SEO. For more information, see Knowledge Base Labels and How to improve SEO using SC labels metadata?.
Icon Upload URL - Get (getIconUploadUrl) https://{{account}}.{{domainName}}/api/kb/labels/v1/getIconUploadUrl

Description

Create an URL for an icon to upload to.

HTTPS OnlyRequired Permissions for API Key: None

Requires Session: True

Request Body

{
    policyId: 123,
    viewId: "124",
    accountId: "125"
}

URL Parameters

Key Example Value Description
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Label - Create (createArticleLabelId) https://{{account}}.{{domainName}}/api/kb/labels/v1/createArticleLabelId

Description

Create a label Id for a new label.

HTTPS Only

Required Permissions for API Key: None

Requires Session: True

https://ACCOUNT.nanorep.co/api/kb/labels/v1/createArticleLabelId?sid=123&kb=345


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Labels - Get (getUserLabels) https://{{account}}.{{domainName}}/api/kb/labels/v1/getUserLabels

Description

Retriev a list of all user labels.

HTTPS Only

Required Permissions for API Key:None

Requires Session: True

https://ACCOUNT.nanorep.co/api/kb/labels/v1/getUserLabels?sid=123&kb=345


URL Parameters

Key Example Value Description
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Labels - Update or Delete (saveUserLabels) https://{{account}}.{{domainName}}/api/kb/labels/v1/saveUserLabels

Description

Update or remove labels for a knowledge base.

HTTPS Only

Required Permissions for API Key:None

Requires Session: True

Request Body

{
    "update": [{
        "name":"Label 1",
        "id":123,
        "color":"#000000",
        "update":[]
        "delete":[]
        "isSupportCenterLabel":false
        "textColor":"#FFFFFF"}
    ,{
        "name":"Label 2",
        "id":124,
        "color":"#000000",
        "update":[]
        "delete":[]
        "isSupportCenterLabel":true,
        "textColor":"#FFFFFF",
        "icons":[
        "https://nr-qa-server1.s3.amazonaws.com/kbLabels/8CB9462EF4BBF12/4641DE1/46421BA/1/1.jpeg"
        ]
    }],
    "delete":[123456,654321]
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.

Reports & Analytics

The Reports & Analytics REST API calls get and update tracking and statistical information in the Bold360 AI Console.
Analytics - Get (get) http://{{account}}.{{domainName}}/api/analytics/v1/get

Description

This API provides data from the nanorep Analytics system, and can provide data-point information usable for charts and other reporting needs.

Required Permissions for API Key: Analytics:Read

http://ACCOUNT.nanorep.co/api/analytics/v1/get?cb=callback&account=ACCOUNTNAME&apiKey=APIKEY&maxOutputRows=200&days=30&values=source.kbname%2Csource.time%2Ccontent.query%2Csource.domain&groupBy=source.kbname


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
Answer - Give Feedback (feedback) http://{{account}}.{{domainName}}/api/analytics/v1/track/feedback

Description

Allow the end-user to provide feedback about an article or search results. For more information regarding context, see What are Bold360 AI Contextual Answers?.


URL Parameters

Key Example Value Description
articleId 1654002601 (REQUIRED) [String] Article Id: The Id number shown on the page when editing an article (answer) in the Bold360 AI Console's Knowledgebase
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
feedbackReason [Enum] (Default is none) Reason why the user is giving feedback: none, wrongAnswer (article is not related to query), or wrongContent (article text is incorrect).
feedbackText That's not what I meant [String] The user's feedback text
feedbackType [Enum] (Default is none) Type of feedback: negative (dislike), none, or positive (like)
kb myKB (REQUIRED if not part of a session) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
kbLC es [String] Language Code: ar (Arabic), de (German), en (English), es (Spanish), fr (French), it (Italian), iw (Hebrew), nl (Dutch), pl (Polish), Portuguese (pt), ru (Russian), or sv (Swedish)
ksId 0 (REQUIRED) Kewordset Id of the thumbed (liked/disliked) answer
prevEventId 123456 The eventId that the agent got from a previous call to Answer - Give Feedback API. Must be sent in subsequent requests.
sid 8926008647916414053 (REQUIRED if part of a session) Session Id: The sessionId value, returned by the Session - Start (hello) API call
src FAQ (REQUIRED) [String] Tracking Category: Used for Analytics. See the description of Interface Source at the top of the REST API & SDK Reference doc page.
text The search query received the result
Answer - Track (markasused) INTERNAL ONLY https://{{account}}.{{domainName}}/api/kb/v1/markasused

Description


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
answerId The Id of the answer object to affect
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
modified False if the answer was used by the agent unchanged. true if the agent changed the answer text before using it.
Answer - Track Collapse (collapse) http://{{account}}.{{domainName}}/api/analytics/v1/track/collapse

Description

Track answer-collapse.

Required Permissions for API Key: None

http://ACCOUNT.nanorep.co/api/analytics/v1/track/collapse?cb=callback&text=how%20much%20%does%20it%20costs&kbLC=en&ksId=0&articleId=634030922498641047&sid=4561231&prevEventId=123456


URL Parameters

Key Example Value Description
articleId Answer Id. received by q.js and a.js.
auto true if answer collapsed automatically, false otherwise.
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kbLC Knowledge-base language code. Given by cnf.js, and from q.js request. For example: ‘iw’, ‘en’, ‘es’, ‘fr’
ksId Keywordset ID of the thumbed answer. received by q.js and a.js.
prevEventId The exact eventId that the agent got from previous call to v2 addFeedback API. Must be sent in subsequent requests.
sid 8926008647916414053 (REQUIRED if part of a session) Session Id: The sessionId value, returned by the Session - Start (hello) API call
src (REQUIRED) [String] Tracking Category: Used for Analytics. See the description of Interface Source at the top of the REST API & SDK Reference doc page.
text The search query received the result.
Answer - Track Expand (expand) http://{{account}}.{{domainName}}/api/analytics/v1/track/expand

Description

Track answer-expand.

Required Permissions for API Key: None

http://ACCOUNT.nanorep.co/api/analytics/v1/track/expand?cb=callback&text=how%20much%20%does%20it%20costs&kbLC=en&ksId=0&articleId=634030922498641047&sid=4561231&prevEventId=123456


URL Parameters

Key Example Value Description
articleId Answer Id. received by q.js and a.js.
auto true if answer expanded automatically, false otherwise.
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kbLC Knowledge-base language code. Given by cnf.js, and from q.js request. For example: ‘iw’, ‘en’, ‘es’, ‘fr’
ksId Keywordset ID of the thumbed answer. received by q.js and a.js.
prevEventId The exact eventId that the agent got from previous call to v2 addFeedback API. Must be sent in subsequent requests.
sid 8926008647916414053 (REQUIRED if part of a session) Session Id: The sessionId value, returned by the Session - Start (hello) API call
src FAQ (REQUIRED) [String] Tracking Category: Used for Analytics. See the description of Interface Source at the top of the REST API & SDK Reference doc page.
text The search query received the result.
Article - Increment FAQ Stats (incrementFAQstats) https://{{account}}.{{domainName}}/api/analytics/v1/incrementFAQstats

Description

Increment article statistics

HTTPS Only

Required Permissions for API Key: None

Requires Session: True

https://ACCOUNT.nanorep.co/api/analytics/v1/incrementFAQstats?account=ACCOUNT&kb=KB_ID&a=78540046&referer=API


URL Parameters

Key Example Value Description
a Article id
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
referer referringURL/referringPage.html (REQUIRED) [String] Page referer: The address of the existing, previous web page from which a link to the current web page was followed
Article - Increment Support Center Stats (incrementSCstats) http://{{account}}.{{domainName}}/api/analytics/v1/incrementSCstats

Description

Increment article Statistics resolved by support center

Required Permissions for API Key: None

http://ACCOUNT.nanorep.co/api/analytics/v1/incrementSCstats?account=ACCOUNT&kb=KB_ID&aid=78540046&ref=API


URL Parameters

Key Example Value Description
account
Audit Log - Get (v1) https://{{account}}.{{domainName}}/api/auditing/v1

Description

Retrieve the audit log for the selected date/time range. Logs include information about changes made by users or by an automatic process in the Bold360 AI system itself. Version: 1 Required Permissions for API Key: Analytics:Read HTTPS Only: True Requires Session: False Example: https://myAccount.myDomain.com/api/auditing/v1?download=true&apiKey=myApiKey&eventType=1,2,3

URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
dateFrom 2019-01-01T00:00 [String] Date to get the event from in format 'yyyy-MM-ddTHH:mm'
dateTo 2019-11-19T08:07 [String] Date to get the event to in format 'yyyy-MM-ddTHH:mm'
download true [Boolean] (Default is false) Trigger browser file download
eventType 1, 2, 3 [Number] (Default is all) Type of Event: Zero or more (comma separated) values. as follows: 1 (widget-common) 2 (widget-embedded) 3 (widget-floating) 4 (widget-domain) 5 (widget-facebook) 6 (widget-advise) 10 (channels) 11 (labels) 20 (ticketing-basics) 21 (ticketing-rules) 22 (ticketing-signature) 23 (ticketing-SLA) 30 (support center) 31 (support center-template) 40 (users) 50 (apiKey) 60 (kb-context) 61 (kb-synonyms)
format xls [String] (Default is csv) Result format: Either csv (Comma-separated values) or xls (Excel)
kb myKB [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Response | Code: 200

timestamp,userId,user_name,container,event_type,event_type_desc,data
11/15/2019 09: 16: 45, 1094040701,FLastSr,Bold360, 61,kb_synonyms, "{""v"":1,""name"":""Synonyms"",""key"":""Synonyms Updates"",""value"":""[""help"",""support""]"",""oldValue"": ""[""support""]""}"
9/23/2019 15: 55: 43, 0, [nanorep] LastJrF,Bold360, 10,channels, "{""v"":1,""name"":""Bold360 Live Chat Escalation"",""key"":""active"",""value"":true,""oldValue"":false}"
7/19/2019 19: 28: 15, 0, [nanorep] FirstL,Bold360, 11,labels, "{""v"":1,""name"":"""",""key"":""removeLabel"",""value"":"""",""oldValue"":""[Knowledge-all articles](1234567890)""}"
                  
Event - Enable Tracking (event) http://{{account}}.{{domainName}}/api/analytics/v1/track/event

Description

Enable tracking of an event.

Required Permissions for API Key: None

http://ACCOUNT.nanorep.co/api/analytics/v1/track/event?eventName=Integration%20Test%20Event&eventParams=%7B%22Test%20param%20one%22%3A%22value%20one%22,%22Test%20param%20two%22%3A%22value%20two%22%7D


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
eventName Event name.
eventParams JSON name-value array. e.g. {'Test param one':'value one','Test param two':'value two'}
identityParams If sid is not specified, values from identityParams are associated with a new session. JSON name-value array. e.g. {'Test param one':'value one','Test param two':'value two'}
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Event - Track (trackEvent) http://{{account}}.{{domainName}}/api/widget/v1/trackEvent

Description

Write an event to the log.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

Required Permissions for API Key: None

Requires Session: True

Example:http://ACCOUNT.nanorep.co/api/widget/v1/trackEvent?sid=SessionId&eventType=4&text=TEXT&data={"key":"value"}


URL Parameters

Key Example Value Description
articleId The article associated with the event
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
conversationId [String] The conversation Id from the Conversation - Create (create) response, if a conversation event
data Extra data on the event.
eventType 4 (REQUIRED) [Number] Type of Event: 1 (sessionStart), 2 (systemEvent), 3 (suggestionSelected), 4 (search), 6 (answerLink), 7 (escalation), 8 (conversion), 9 (positiveFeedback), 10 (negativeFeedback), 11 (action), 18 (conversationOption)
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
text
Events - Export (get) https://{{account}}.{{domainName}}/api/events/v1/get

Description

This API allows to get a raw dump of events tracked in the nanorep system, including searches, channeling, etc.

HTTPS Only

Required Permissions for API Key: Analytics:Read

https://ACCOUNT.nanorep.co/api/events/v1/get?eventType=EVENT_TYPES&download=true&apiKey=APIKEY


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
Reports - Get (get) http://{{account}}.{{domainName}}/api/report/v1/get

Description

Generate custom report data based on tracked events. Supports advanced grouping and sorting to tailor the data to your needs.

Required Permissions for API Key: Analytics:Read

http://ACCOUNT.nanorep.co/api/report/v1/get?account=ACCOUNT&apikey=KEY&days=90&fields=FIELD1,FIELD2&sortBy=FIELD1&groupBy=FIELD1&FIELD1=FILTERVALUE


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
Server Status - Get (getStatus) INTERNAL ONLY http://{{account}}.{{domainName}}/api/server/v1/getStatus

Description

Get the status and totals for the server.

Version: 1

Required Permissions for API Key: Analytics:Read

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/server/v1/getStatus


URL Parameters

Key Example Value Description
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).

Response | Code: 200

nanoRep System 4.98.8.1003  @my.nanorep.com
<br/>
Web Version: 4.98.8.1003
<br/>
Up-time: 0.03:40:17
<br/>
Server Name: US1-1
<br/>
Provision: 101
<br/>
<br/>
End User IP: 67.248.105.159
<br/>
User Agent: PostmanRuntime/7.20.1
<br/>
Parsed User Agent: Unknown/Other//Other/
<br/>
<br/>
<u>
    <b>FULL GC:</b>
</u>
<br/>
Last Full GC Approach: 
1/1/1 00:00:00.000
<br/>Last Full GC Complete: 
1/1/1 00:00:00.000
<br/>
                  
Server Status, Extended - Get (exStatus) INTERNAL ONLY http://{{account}}.{{domainName}}/exStatus

Description

Get the extended server status. Requires an admin API key or admin user SSO authentication. Supported on admin-console-sso enabled servers.

Version: None

Required Permissions for API Key: Analytics:Read

HTTPS Only: False

Requires Session: False Example: http://ACCOUNT.nanorep.co/exStatus


URL Parameters

Key Example Value Description
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
Visitor - Track (visitorToken) http://{{account}}.{{domainName}}/api/v1/visitorToken

Description

Synchronize and retrieve a visitor token (cookie). If the URL parameters are not specified, a new one gets created.

Required Permissions for API Key: None

http://ACCOUNT.nanorep.co/api/v1/visitorToken?cb=callback&visitorToken=1f5e393a-585d-43dc-8814-57c13dfbc7e4


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
visitorToken
Voice Data - Get (getVoiceData) INTERNAL ONLY http://{{account}}.{{domainName}}/api/voices/v1/getVoiceData

Description

Get data for a voice.

Version: 1

Required Permissions for API Key: Analytics:Read

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/voices/v1/getVoiceData?dateFrom=2017-01-04T22:00&UTCDiff=3&dateSelectionType=3&kb=70310357&analysisType=4&apiKey=ApiKey&lastDays=5&lastMonths=3&dateTo=2017-06-12T20:59&voiceId=900143462


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
outputEvents true [Boolean] (Default is false) Whether to include events in the output
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
voiceId The voice Id
Voices API - Export (export) https://{{account}}.{{domainName}}/api/voices/v1/export

Description

Retrieve the Voices analysis for the selected time range

HTTPS Only

Required Permissions for API Key: Analytics:Read

https://ACCOUNT.nanorep.co/api/voices/v1/export?account=ACCOUNT&apiKey=API_KEY&kb=English&format=json&trend=14&download=DOWNLOAD&voiceType=EVENTS&context=CONTEXT&cb=CB


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call

Server Details

The Server Details REST API calls are for managing the server.

Answered Sessions Total - Get (totalanswered) INTERNAL ONLY http://{{account}}.{{domainName}}/api/server/v1/totalanswered

Description

Get the total number of answered sessions on the server.

Version: 1

Required Permissions for API Key: None

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/server/v1/totalanswered


URL Parameters

Key Example Value Description
func callback function

Response | Code: 200

({total:999999999})

                  
Dashboard Messages - Get (getmessages) INTERNAL ONLY http://{{account}}.{{domainName}}/api/server/v1/getmessages

Description

Get the dashboard messages for all accounts on the server per the message Id. Note this returns Text, not JSON.

Version: 1

Required Permissions for API Key: Real Time Interaction Data:Read

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/server/v1/getmessages?mid=5&c=cb


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
mid (REQUIRED) [Number] Message id - Minimum message Id (get all the messagse that have this lowest Id)

Response | Code: 200

{globalAnsweredSessions:100,messageCount:90,messages:[
{id:36865,type:101,lon:'31.5497207641602,lat:'74.3436126708984',text:'How do I fix audio feedback (echo, static) during my session?'},
{id:36866,type:101,lon:'32.0258102416992',lat:'35.8645782470703',text:'Add an Email Address for Security Alerts'},
{id:36867,type:101,lon:'51.5085296630859',lat:'-0.125740006566048',text:'Join a Test Session'}]}
                  
Version - Upgrade (upgrade) INTERNAL ONLY https://{{account}}.{{domainName}}/api/cd/v1/upgrade

Description

* CAUTION! * Upgrade the server version to the latest deployed one. AFFECTS ALL ACCOUNTS.

Version: 1

Required Permissions for API Key: RealTimeInteractionData:Write

HTTPS Only: True

Requires Session: False Example: https://SERVER.nanorep.com/api/cd/v1/upgrade?apiKey=1-2-3-4


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).

Sessions

The Sessions REST API calls process the HTTP session that manages an information exchange between your system and the Bold360 AI server. A session can be thought of as a visit in which you perform one or more request-response transactions. Sessions are time-based. After you call Session - Start (hello), its response shows the inactivity timeout value. The session remains active as long as you make API calls using the session Id. When you don't, the session becomes inactive. When the session's inactivity time reaches the timeout, Bold360 AI closes the session. You may call: * Session - Close (die) to end the session; or * Session - Keep-alive (keepalive) to reset the session's lifetime to the original value. This is useful when uploading a file that might take longer than the timeout.
Answered Sessions Total - Get (totalanswered) INTERNAL ONLY http://{{account}}.{{domainName}}/api/server/v1/totalanswered

Description

Get the total number of answered sessions on the server.

Version: 1

Required Permissions for API Key: None

HTTPS Only: False

Requires Session: False

Example: http://ACCOUNT.nanorep.co/api/server/v1/totalanswered


URL Parameters

Key Example Value Description
func callback function

Response | Code: 200

({total:999999999})

                  
Language - Detect (detectLanguage) INTERNAL ONLY http://{{account}}.{{domainName}}/api/widget/v1/detectLanguage

Description

Detect the language code from the specified text


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
text Text string to be used for the language detection
Session - Close (die) http://{{account}}.{{domainName}}/api/widget/v1/die

Description

Close a session. All search and voice statistics are saved when the session ends.

Required Permissions for API Key: None

Requires Session: True

http://ACCOUNT.nanorep.co/api/widget/v1/die?cb=callback&sid=4312481093


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Session - Keep-alive (keepAlive) http://{{account}}.{{domainName}}/api/widget/v1/keepAlive

Description

Keep the session alive. Used during file uploads and active chat sessions to prevent the server from closing the session. As long as these are sent, the session will not end.

*Requires session

Required Permissions for API Key: None

http://ACCOUNT.nanorep.co/api/widget/v1/keepAlive?cb=callback&sid=4312481093


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Session - Start (hello) https://{{account}}.{{domainName}}/api/widget/v1/hello

Description

Start a new Session, and get a Session Id.

While only the url is required, unpredictable results will occur if you only specify it when you have more than one knowledge base. In that case, you should also specify a kb or a configId.

For more information, please see the overview description to the Session module.

Version: 1

Required Permissions for API Key: None

HTTPS Only: False

Requires Session: False

Example: https://myAccount.myDomain.com/api/widget/v1/hello?url=http%3A//mySite.com


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
configId myConfigId (REQUIRED if kb is not specified) [String] Config Id: The Domain API ID value shown in the Bold360 AI Console: TOUCHPOINTS > Widgets, choose your widget type, and select the Advanced tab
context brand:apple,deviceType:tablet [String] Session Context: Key-Value pairs to hold session data in the format of key:value,key:value,... For more information, please see the Bold360 AI Console's help about "Contextual Answers".
kb myKB (REQUIRED if configId is not specified) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
nostats true [Boolean] (Default is false) No Statistics: true (to disable) or false (to enable) tracking for this session.
url http%3A//mySite.com (REQUIRED) [String] Your URL: Your website's URL that is initiating this session with the API (aka the referer)
values key1:value1,key2:value2 [String] [TODO-500 server error.] Session Values: Key-Value pairs to hold additional data you want to keep with the session, such as user information, in the format of key:value,key:value,...

Response | Code: 200

{
    "sessionId": "6445581692886625120",
    "timeout": 180,
    "server": "domain"
}
                  
Session Text - Translate (translation) http://{{account}}.{{domainName}}/api/widget/v1/translation

Description

Translate text for the current session

Required Permissions for API Key: None

Requires Session: True


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
from Language to translate from
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
text Text to translate
to Language to translate to
Temporary File - Delete (deleteUploadedFile) INTERNAL ONLY http://{{account}}.{{domainName}}/api/widget/v1/deleteUploadedFile

Description

Delete a file uploaded in the current session that was not added to a contact form.


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
data String which represents the file to delete. Format: “bucket,path”
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
Translation - Fail (translationfailed) INTERNAL ONLY http://{{account}}.{{domainName}}/api/widget/v1/translationfailed

Description

Report a translation failed


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
errorCode 0 [Number] Error code: 0 (TranslationTimeout), or 1 (TranslationApiFallback), or 2 (DetectionTimeout), or 3 (DetectionApiFallback), or 4 (TranslationDead)
message Additional data on the failure
provider 0 Translation provider: 0 (GoogleV1), or 1 (Microsoft), or 2 (GoogleV2)
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call

Settings

The Settings REST API calls get configurations in the Bold360 AI Console.
Domain Config - Copy (copyConfiguration) INTERNAL ONLY https://{{account}}.{{domainName}}/api/domain/v1/copyConfiguration

Description

Copy all domain configuration settings from one domain configuration to another.

HTTPS Only: True

Requires Session: True


URL Parameters

Key Example Value Description
sid 8926008647916414053 Session Id: The sessionId value, returned by the Session - Start (hello) API call
sourceDomainId 1 (REQUIRED) [Number] Id of the domain configuration to import from
targetDomainId 2 (REQUIRED) [Number] Id of the domain configuration that are updated
widgetType float [String] (Default is embed) Widget type: embed (embedded widget) or float (floating widget) or advise (advise widget)
Domain Config Details - Get (details) INTERNAL ONLY https://{{account}}.{{domainName}}/api/domain/v1/details

Description

Retrieve the details about a domain configuration


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
domainId Id of the requested domain config
Domain Configs - Get (list) INTERNAL ONLY https://{{account}}.{{domainName}}/api/domain/v1/list

Description

Retrieve the list of domain configurations


URL Parameters

Key Example Value Description
account myAccount Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
Localization - Get (getLocalization) http://{{account}}.{{domainName}}/api/widget/getLocalization

Description

Get the localization messages that belong to the specified language

Required Permissions for API Key: None

http://ACCOUNT.nanorep.co/api/widget/getLocalization?lang=en


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
lang en Language Code: ar (Arabic), de (German), en (English), es (Spanish), fr (French), it (Italian), iw (Hebrew), nl (Dutch), pl (Polish), Portuguese (pt), ru (Russian), or sv (Swedish)
Notifications - Get (getSettings) INTERNAL ONLY http://{{account}}.{{domainName}}/api/notifications/v1/getSettings

Description

Get the notifications settings for the specified knowledge base.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.com/api/notifications/v1/getSettings?kb=KB&apiKey=API_KEY


URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.

Response | Code: 200

{
	"notificationEnabled": true,
	"settings":{
		"assigneeChangedNotifiers": [12345, 56789],
		"publishNotifiers": [22222, 454545],
		"sendNotoficationsToAssignee": true
	}
}
                  
Notifications - Set (setSettings) INTERNAL ONLY http://{{account}}.{{domainName}}/api/notifications/v1/setSettings

Description

Update the notifications settings for the specified knowledge base.

Version: 1

Required Permissions for API Key: None

HTTPS Only: False

Requires Session: False

Example: http://SERVER.nanorep.com/api/notifications/v1/setSettings?kb=KB&apiKey=ApiKey

In Postman, the Request Body works as raw, Text. Others might work, too.

Request Body

{
    "notificationEnabled": true,
    "settings":{
        "assigneeChangedNotifiers": [12345, 56789],
        "publishNotifiers": [22222, 454545],
        "sendNotoficationsToAssignee": true
    }
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
kb myKB Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
Widget Configuration - Get (cnf) http://{{account}}.{{domainName}}/api/widget/v1/cnf

Description

Get the widget configuration information for the account.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False

Example: https://myAccount.myDomain.com/api/widget/v1/cnf?account=myAccount


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
configId myConfigId Config Id: The Domain API ID value shown in the Bold360 AI Console: TOUCHPOINTS > Widgets, choose your widget type, and select the Advanced tab
preview true [Boolean] (Default is false) Preview: true (to disable) or false (to enable) counting statistics
referer referringURL/referringPage.html [String] Page referer: The address of the existing, previous web page from which a link to the current web page was followed
widgetType float [String] (Default is embed) Either embed, float, or advise

Response | Code: 200

ISQ.Cnf_Embed = {"serverUrl" : "my.nanorep.com",
"id" : "1000259671",
"domainURL" : "All Domains",
"cacheVar" : "637061393735938753",
"accountUrl" : "account.domain",
"limited" : false,
"translationLanguages" : "es,fr,it,ja",
"chatEnabled" : false,
"goResponseBranding" : false,
"integrateWithGA" : true,
"autocompleteEnabled" : true,
"autocomplete_maxQueryLength" : 5,
"hasGuides" : false,
"guides" : [],
"uiLanguageCode" : "en",
"kbId" : "1071169051",
"kbName" : "Bold360",
"kbLanguageCode" : "en",
"eventTrackingSamplingLevel" : 0.1,
"supportCenterDomain" : "",
"customEscalationLink" : "",
"customEscalationLink_target" : 1,
"mobileWidgetEnabled" : true,
"useCustomEncoding" : false,
"customEncoding" : "windows-1255",
"supportBlockQuotes" : true,
"translationEnabled" : false,
"translationApiKey" : "Microsoft:'key1',GoogleV1:'key2',GoogleV2:'key3'",
"chatConfiguration" : "{\"active\":null,\"LP\":{\"id\":null,\"server\":null,\"apiKey\":null},\"nR\":{},\"skill\":null,\"maxAvailabilityTime\":0,\"preChat\":false,\"postChat\":false,\"preChatEncoding\":null,\"showEmailButton\":false,\"popup\":{\"enabled\":false,\"size\":null},\"hideSendToEmail\":false,\"heightInDynamicEmbed\":0}",
"showChatConfiguration" : 0,
"customEscalationLink_Action" : 1,
"chatCallingStatus" : "",
"skinName" : "Modern Support Center",
"widgetVersion" : "v2",
"titleNormalText" : "What are you looking for?",
"titleTeaserText" : "What are you looking for?",
"customChatButtonText" : "",
"customEmailButtonText" : "Email",
"hideByEmailIcon" : false,
"customAskRepByText" : "Contact Us:",
"customNoAnswersText" : "No results for '{QUERY}'. Try a different phrasing or contact support. ",
"readOnlyModeAlert" : "",
"topicPostConfirmationText" : "",
"showSupportCenterArticleOpenerLink" : true,
"sharingSupportCenterLinkProtocol" : "2",
"enableSharingOptions" : true,
"availableSharingChannels" : 3,
"promotionalArticleId" : -1,
"promotionalArticlePosition" : "",
"answerFooter" : "",
"showFooterOnlyOnLastAnswer" : true,
"initialText" : "Type your question here...",
"widgetBackgroundColor" : "#F0F0F0",
"feedbackType" : 1,
"feedbackDialogType" : 0,
"autoGrabFocusInEmbed" : true,
"autoQuestions" : "",
"autoQuestionsInterval" : "5000",
"autoQuestionsTypeEffect" : true,
"repeatAutoQuestions" : true,
"onloadQuestionId" : "-1",
"applyLabelToTickets" : "",
"showLogoInCollapsedMode" : false,
"showFooterWithContactForm" : true,
"titleBGColor" : "",
"customScript" : "",
"persistentChannelingBar" : false,
"enableSearchInBody" : false,
"showSearchButton" : true,
"customCSS" : "\t td.answerTitle, .answerTitle .titleText h3, #widgetContainer .nr-answering-answer-title {\t color: #444444;}\t td.answerBody *, .nr-answering-answer-content * {}\t td.answerBody, .nr-answering-answer-content {\t color: #444444;}\t .answerTable TD A, .answerBackLinkContainer A, .nr-answering-answer-content a {\t color: #479FFE;}\t .answerTable .pagerLink.next, .answerTable .pagerLink.prev {\t background-color: #479FFE;}",
"customization":{"titleFont":"",
"answerTitleColor":"#444444",
"answerTitleFont":"",
"answerBodyColor":"#444444",
"answerBodyFont":"",
"widgetBackgroundColor":"#F0F0F0"
},
"voiceEnabled" : false,
"mobileResponsive" : false,
"feedbackCustomiseText" : "Was this article helpful?",
"feedbackSubmissionText" : "We are sorry to hear that! Tell us how we can improve.",
"feedbackBottomText" : "Submit",
"feedbackPositiveButtonText" : "Yes",
"feedbackNegativeButtonText" : "No",
"languageDictionary" : "initializeNS(\"ISQ.Widget.Texts\");ISQ.Widget.Texts.en={filesDeleted:\"Due to a connection error, your files has been deleted. please upload the files again\",fileBlockedFileSize:\"Attachment failed. Max file size is %var% MB.\",fileExtensionBlocked:\"File extension %var% is not permitted\",fileMaxReached:\"You cannot add anymore files\",fileBlocked:\"You can't add attachments at this time, please try again later\",chooseFile:\"Choose file...\",dir:\"ltr\",textAlign:\"left\",negativeTextAlign:\"right\",titleTeaserText:\"Get Instant Answers:\",titleNormalText:\"Get Instant Answers:\",loginError:\"Oops... something went wrong. Please try again later\",askNowLink:\"Ask an Agent\",chatNow:\"Chat with an Agent\",askBy:\"Ask an Agent by:\",email:\"Email\",chat:\"Chat\",newSearch:\"New Search\",xmlObjectError:\"Error parsing xml. unable to continue.\",searchMsgResults:\" or \",searchMsgNOResults:\"No results for '{QUERY}'. Try a different phrasing or ask an agent.\",searchMsgNOResultsContext:\"No answer found for '{CONTEXT}'. Contact us today and let us know\",wrongLogin:\"Oops... something went wrong. Please try again\",closeChat:\"End chat\",sendBtn:\"Send\",like:\"Like!\",dislike:\"Dislike\",chatCallingStatus:\"Please wait for an agent to answer...\",chatTyping:\" is typing...\",chattingNow:\"Chatting with \",chatJoined:\" has joined the chat.\",chatClosed:\"Chat closed\",chatConnectionError:\"Oh, snap! Looks like we lost connection to the server. Try refreshing the page in a few minutes.\",resumeChat:\"Chat resumed\",quickAnswer:\"Suggested answer:\",sendChat:\"Send\",confirmEndChat:\"This will end your chat session. Are you sure?\",me:\"Me\",emailChat:\"Email this chat transcript\",emailChatSent:\"Your chat transcript will be sent to your email address at the end of your chat\",enterEmail:\"Enter Email\",emailValidation:\"Please enter a valid email address\",cancel:\"Cancel\",back:\"&lt; Back\",translating:\"Translating\",next:\"Next &gt;\",prev:\"&lt; Prev\",readOnlyModeAlert:\"Temporarily unavailable\",topicPostConfirmationText:\"Thank you for submitting your question, you will receive an email reply shortly.<br/><br/>In the meantime, feel free to ask any further questions you may have in the box above.\",useThisAnswer:\"Use This Answer\"};",
"skinCustomRTLCSSfile" : "/widget/skins/supportCenterModern/rtl.css",
"skinCSS" : "Example CSS",
"stickyAnswerFooter" : true,
"embeddedWidgetHeightDynamic" : true,
"faqData" : "context-dependent"};
                  

SSOs

The SSOs REST API calls manage single sign-on configuration and operation in the Bold360 AI Console.
Authentication Configuration - Get (authConfiguration) http://{{account}}.{{domainName}}/api/auth/v1/authConfiguration

Description

Return the available login modes for the current account.

Required Permissions for API Key: None

https://ACCOUNT.nanorep.co/api/auth/v1/authConfiguration


URL Parameters

Key Example Value Description
forceAdmin Use the admin account instead of resolving it from the host name.
SSO Console - Login (sso) http://{{account}}.{{domainName}}/console/sso

Description

Perform an SSO login to the console using the SAML protocol.

Required Permissions for API Key: None

https://ACCOUNT.nanorep.co/console/sso


URL Parameters

Key Example Value Description
forceAdmin Use the admin account instead of resolving it from the host name.
SSO Settings - Get (getAuthenticationInformation) https://{{account}}.{{domainName}}/api/kb/v1/getAuthenticationInformation

Description

Return the Single Sign-On configuration for the current account.

HTTPS Only

Required Permissions for API Key: KB:Read

Requires Session: True

https://ACCOUNT.nanorep.co/api/kb/v1/getAuthenticationInformation

SSO Settings - Set (updateAuthenticationInformation) https://{{account}}.{{domainName}}/api/kb/v1/updateAuthenticationInformation

Description

Configure the Single Sign-On settings for the current account.

HTTPS Only

Required Permissions for API Key: KB:Write

Requires Session: True

https://ACCOUNT.nanorep.co/api/kb/v1/updateAuthenticationInformation


URL Parameters

Key Example Value Description
authRequestXml The authentication request template.
enabled Determines whether Single Sign-On is enabled for the current account.
forced Determines whether Single Sign-On is the only allowed login option for the current account.
type The type of the authentication must be 'saml'
xml The SAML meta data XML specified by the identity provider.
Suggested Renewal Time - Get (getSuggestedRenewal) http://{{account}}.{{domainName}}/api/auth/v1/getSuggestedRenewal

Description

Get the time, as an Epoch (Unix Timestamp), when the client needs to initiate an SSO renewal.

Required Permissions for API Key: None

https://ACCOUNT.nanorep.co/api/auth/v1/getSuggestedRenewal


URL Parameters

Key Example Value Description
kbId (REQUIRED if referring a Support Center SSO. Must not be present when referring a Console SSO) Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call

Support Centers

The Support Centers REST API calls manage the Support Centers in the Bold360 AI Console.
Contact Form Files - Request Upload (getFileUploadParams) http://{{account}}.{{domainName}}/api/widget/v1/getFileUploadParams

Description

Get arguments for uploading a file to S3 storage. The files are used in contact forms only. File paths that aren’t added to contactForm data are deleted when the session ends.

Required Permissions for API Key: None

Requires Session: True

http://ACCOUNT.nanorep.co/api/widget/v1/getFileUploadParams?cb=callback&sid=1122334


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
data Upload params info Format: “sessionID,Max-file-size”. currently max file size is 10MB
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Support Center - Create (createSupportCenter) https://{{account}}.{{domainName}}/api/supportcenter/v1/createSupportCenter

Description

Create a new support center under a knowledge base.

Version: 1

Required Permissions for API Key: KB:Write

HTTPS Only: True

Requires Session: True

Request Body

{
    name: "Your Support Center Name", 
    domain: ""
}

URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 1213866232942359736 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call

Response | Code: 200

{"supportCenterId":123456789}
                  
Support Center - Get (getSupportCenter) https://{{account}}.{{domainName}}/api/supportcenter/v1/getSupportCenter

Description

Retrieve a support center's basic configuration.

HTTPS Only

Required Permissions for API Key: None

Requires Session: True

https://ACCOUNT.nanorep.co/api/supportcenter/v1/getSupportCenter?supportCenterId=123&kb=345


URL Parameters

Key Example Value Description
supportCenterId (REQUIRED) [String] The support center Id
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
Support Centers - Get (getAllSupportCenters) https://{{account}}.{{domainName}}/api/supportcenter/v1/getAllSupportCenters

Description

Retrieve a list of all support centers for kb.

HTTPS Only

Required Permissions for API Key: KB:Read

Requires Session: True

https://ACCOUNT.nanorep.co/api/supportcenter/v1/getAllSupportCenters?sid=123&kb=345


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Template - Update (updateTemplate) https://{{account}}.{{domainName}}/api/supportcenter/v1/updateTemplate

Description

Update a template.

HTTPS Only

Requires Session: True

Request Body

{
    "supportCenterId" : "921307272",
    "index" : "128",    //Template index
    "value" : ""
}

URL Parameters

Key Example Value Description
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
Templates - Get (getAllTemplates) https://{{account}}.{{domainName}}/api/supportcenter/v1/getAllTemplates

Description

Retrieve all the templates for a support center.

HTTPS Only

Required Permissions for API Key: None

Requires Session: True

https://ACCOUNT.nanorep.co/api/supportcenter/v1/getAllTemplates?supportCenterId=123&kb=345


URL Parameters

Key Example Value Description
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
supportCenterId Support Center Id
Templates - Update (updateTemplate) INTERNAL ONLY http://{{account}}.{{domainName}}/api/supportcenter/v1/updateTemplate

Description

Update the support center page templates by type.

Version: 1

Required Permissions for API Key: KB:Read

HTTPS Only: False

Requires Session: False


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
data (REQUIRED) [String] The updated template data
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
successRedirectionUrl Path to redirect on success
templateType 1 Template type: 1 (master), 2 (homepage), 3 (label page), 4 (article page), 5 (error page), 6 (TrackingScript), 7 (widgetScript), 8 (css), or 9 (google Crawling)
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.

Tickets

The Tickets REST API calls get and set information for tickets (Support issues).

Ticket - Create (create) https://{{account}}.{{domainName}}/api/tickets/v1/create

Description

Create a new ticket in the knowledge base.

For more information regarding context, see What are Bold360 AI Contextual Answers?.

HTTPS Only

Required Permissions for API Key: None

Request Body

email:
 example@example.com
 labelid:
 the Labels ID
 subject:
 This is the title of the ticket
 body:
 the body
 file:**
 context:
 contextKey:value,contextKey:value
 account:
 ACCOUNT_NAME
 kb: 
 KB_ID
 success_redirection_url:
 http://SUCCESS_PATH

URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
bcc
body Body of the item
cc
context deviceType:Android [String] Context: The circumstances that apply to articles, in the format: category:value,category2:value2,...
email Reply email
file Attachment to the item (the form MUST be ‘multipart/form-data’)
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
labelId Adds one or more labels to the new item. Value must be comma-separated IDs of Publishing Center labels
OTHER VALUES Supports adding any custom data as key:Value pair to the ticket details
referer referringURL/referringPage.html (REQUIRED) [String] Page referer: The address of the existing, previous web page from which a link to the current web page was followed
Subject Subject of the item
success_redirection_url Path to redirect on success
Ticket Info - Get (getinfo) http://{{account}}.{{domainName}}/api/tickets/v1/getinfo

Description

Get information about a ticket

Required Permissions for API Key: None

Requires Session: True

http://ACCOUNT.nanorep.co/api/tickets/v1/getinfo?ticketId=5CF574E1E-40ABACA&sid=6796311376686568649


URL Parameters

Key Example Value Description
cb myCallback [String] Callback Name: The name of the callback function, limited to 40 characters, in your client-side code where you want to receive the response from the API call
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
ticketId Ticket ref Id
Tickets - Export (export) http://{{account}}.{{domainName}}/api/ticketing/v1/export

Description

Download ticket data to XML or CSV format.

Required Permissions for API Key: Inbox:Read

http://ACCOUNT.nanorep.co/api/ticketing/v1/export?apiKey=APIKEY&kb=KBNAME&includeText=true&closeOverdue=true&format=xml&month=1&year=2016&account=ACCOUNT


URL Parameters

Key Example Value Description
account myAccount (REQUIRED) [String] Account Name: The name of the account the Bold360 AI system administrator assigns to your organization when it begins using the Bold360 AI product
apiKey {{apiKey}} [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
closeOverdue This is a switch to see which tickets were closed as overdue. True will return tickets that were overdue, wheres false will return tickets that were not overdue.
download Trigger browser file download
format Tickets export format
includeText Whether to include the actual ticket correspondence.
kb myKB (REQUIRED) [String] Knowledgebase Id: The Id or Name value returned by the Knowledge Bases - Get (getKBs) API call
label The label ID in case you want to export tickets from a specific label(in HEX)
month Target month
pw myPassword [String] Your password. Will be deprecated as of March 3, 2020.
username myUserName [String] Your user name: Your full username, in the format of loginId@account, that you use to log into the Bold360 AI Console. This and the password can be used in place of the apiKey query parameter.. Will be deprecated as of March 3, 2020.
year Target year
Tickets - Mask (mask) https://{{account}}.{{domainName}}/api/tickets/v1/mask

Description


URL Parameters

Key Example Value Description
apiKey {{apiKey}} (REQUIRED) [String] API Key: The Id, set in the Bold360 AI Console, that acts as one of your account's secret tokens for authentication and has assigned permission (access rights).
deleteAttachments Controls wehther attachments are deleted as part of the masking process (if marked 'false', must be deleted manually afterwards).
sid 8926008647916414053 (REQUIRED) [String] Session Id: The sessionId value, returned by the Session - Start (hello) API call
ticketIds (Body JSON) Array of ticket ref ids to be masked

_Hidden Parameters

This folder does not contain real requests. It is part of the Internal collection for your reference. Each parameter is only for internal use. So we listed them here, but they really apply to the public-facing requests as indicated in their titles. If you are going to use the requests in Postman, you need to copy them into your own collection (so they do not get overwritten by new releases).


INTERNAL ONLY URL Parameters

Key Example Value Description
includeOfflline true [Boolean] (Default is false) Whether to return offline articles in the search results. Reuires an API KEY with KB:Read permission.
naive false [Boolean] (Defaut is false) Use naive keyword-search algorithm. Disables all NLP features.
searchIn true [String] (Default is Online) KB section to search: Online (standard), or Publishing (not yet published), or All (both). Reuires an API KEY with KB:Read permissi

INTERNAL ONLY URL Parameters

Key Example Value Description
i Widget instance ID. are returned to help find the correct widget for which the result is intended
index Article index in the most popular list are returned to help find the correct article for which the result is intended

INTERNAL ONLY URL Parameters

Key Example Value Description
getSimilarArticles true [Boolean] (Default is false) Get similar phrases

INTERNAL ONLY URL Parameters

Key Example Value Description
_includePhrasings_internal_ true [Boolean] (Default is false) Include phrasings. Being deprecated. Depending on your release level, you might need to use _withPhrasings_ instead.
_phrasingsKind_internal_ entities [Boolean] (Default is false) How will the phrasings be formatted. If set, overrides _includePhrasings_internal_. Being deprecated. Depending on your release level, you might need to use _phrasingsKind_ instead.
phrasingsKind entities [String] How to format phrasings: none, or text, or entities (JSON). Supercedes _phrasingsKind_internal_ depending on your release level.
withContextConfig true Boolean] (Default is false) Include KB context config in the response. Pertains only to JSON.
withPhrasings true [Boolean] (Default is false) Include phrasings. Supercedes _includePhrasings_ depending on your release level.
withProviders true [Boolean] (Default is false) Include KB providers (entities) in the response. Pertains only to JSON.
withSynonyms true [Boolean] (Default is false) Include KB synonyms in the response. Pertains only to JSON.

INTERNAL ONLY URL Parameters

Key Example Value Description
sentiment [String] The channel's sentiment (positive, neutral or negative). Used only if Intentional channeling feature is enabled for the account.

INTERNAL ONLY URL Parameters

Key Example Value Description
sentiment [String] The channel's sentiment (positive, neutral or negative). Used only if Intentional channeling feature is enabled for the account.

INTERNAL ONLY URL Parameters

Run in Postman

We have prepared an SDK in the form of Postman collections for you that make it very easy and convenient to try the REST API calls before adding them to your application.

  1. If you do not yet have Postman, you can get a free version from https://www.getpostman.com. That site also has documentation that explains how to use Postman. You will only need to do this step once.
  2. Set up your Postman Environment. The Environment collection contains the variable names the REST API uses. This rarely changes, so you probably will only need to do this step once, but keep updated by the release notes. Follow the steps for Figures 1 and 2 below.
  3. Click the REST API & SDK button in the navigation menu to open the collection in Postman. This is the complete collection of all REST API calls. As LogMeIn continues to update the REST API with new releases, this button always keeps you current with the latest release.
  4. Click the REST API & SDK- Internal button in the navigation menu to open the REST API INTERNAL USE ONLY collection. This always is current with the latest release.
  5. Execute the calls you want, and observe the results. This gives you insight how you want to use the calls in your own web pages. If this is your first time, the best call to run is Sessions > Session - Start (hello) to ensure your Environment is setup right.

Figure 1 – Open the Environment


Figure 2 – Set the Environment


Key Example Value Description
disableStatistics true [Boolean] (Default is false) Whether to stop gathering conversation statistics. Cannot be false if includeDraftsAndOffline is true.
enableLog false [Boolean] (Default is true) Whether to write to the conversation log
includeDraftsAndOffline true [Boolean] (Default is false) Whether to include both Drafts and Offline
textOnly false [Boolean] (Default is true) Whether to deliver the conversation as text (true) or HTML (false)