Set up API access for AI Answers
The AI Answers API lets your own applications send questions about a Nexus project's content and get answers back. For example, you can use it to build a Slackbot or add answers to your own support site.
You manage the API in the API section of the AI Answers tab. The section has two tabs. On Access you turn the API on and choose who can connect. On API keys you create and revoke keys.
To turn the API on or off:
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
Access the project you want to configure by selecting it in the list.
Select the AI Answers tab.
In the API section, select the API toggle switch.
If the project has API keys, a confirmation dialog opens. Select Turn on or Turn off.
When you turn the API on, API key required is selected by default.
Note
Your API keys stay in the list while the API is off, so you can still revoke them. None of them are accepted until you turn the API back on.
You can only change this while the API is on. To choose who can connect:
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
Access the project you want to configure by selecting it in the list.
Select the AI Answers tab.
In the API section, select the Access tab.
Choose who can connect:
Public: no API key is needed. Any application that knows the API address can connect.
API key required: only applications that send one of this project's API keys can connect.
Your choice is saved as soon as you select it.
Your developers need three values to send requests. They are all on the Access tab, and each has a Copy button:
API address: where your applications send their questions for this project.
Tenant ID: the same for all your projects.
Project ID: unique to this project.
Every request needs both IDs. To learn how to send a request, see AI Answers API reference.
To create an API key:
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
Access the project you want to configure by selecting it in the list.
Select the AI Answers tab.
In the API section, select the API keys tab.
Select Create API key. If the project has no keys yet, the button is called Create key.
In the Name field, enter a name that tells you what the key is for. For example, "Support portal".
Select Create API key.
Select Copy to copy the key, and store it somewhere safe.
Select Done.
Important
The key is only shown once. If you lose it, revoke it and create a new one.
The list shows each key's name and a short part of the key, so you can tell your keys apart.
Revoking a key stops applications that use it from getting answers straight away. Your other keys keep working. You can't undo this.
To revoke a key:
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
Access the project you want to configure by selecting it in the list.
Select the AI Answers tab.
In the API section, select the API keys tab.
Select Revoke next to the key.
In the confirmation dialog, select Revoke API key.
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
|
Access the project you want to configure by selecting it in the list.
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
|
Access the project you want to configure by selecting it in the list.
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
|
Access the project you want to configure by selecting it in the list.
Select Nexus in the top menu. You are presented with the list of current Nexus projects.
|
Access the project you want to configure by selecting it in the list.