What does 'ABI_API_KEY' refer to?

[AntoineTA]

Hi there,

The readme mentions the ABI_API_KEY. I have also noticed that the .env file says

# ABI API Configuration
# Create and add your API key in the GitHub project settings. This key is used to authenticate requests to the ABI API.
ABI_API_KEY=

However, I am not sure what this key is supposed to be? What am I missing? Thanks!

[Dr0p42]

Hello @AntoineTA, thank you for raising that up. The ABI_API_KEY is a "secret" that you can generate freely, and that will be used to protect your ABI api deployment.

I need to document this, but for example you can just put "MyCustomSecretAPIKey" or anything and it will work.

You can check also the ABI api doc, hosted live here: http://abi-api.default.space.naas.ai/redoc#tag/Authentication

ABI_API_KEY must be passed either as:

import requests

url = "https://<your-registry-name>.default.space.naas.ai/assistants/supervisor/completion"

headers = {
    "Authorization": f"Bearer {token}"
}

response = requests.post(url, headers=headers)
print(response.json())

or

import requests

url = "https://<your-registry-name>.default.space.naas.ai/assistants/supervisor/completion?token=<token>"

response = requests.post(url)
print(response.json())

the value of <token> must be the value of ABI_API_KEY

[AntoineTA]

Thanks for the reply! That is much clearer now.