Publish an API in Kernel

Guidelines

As a prerequisite for building an experience in ATRIA, the aura-gateway-api API must be published in Kernel.

For this purpose, follow the instructions below:

• Request Kernel team to configure in the corresponding Kernel environment the scopes needed to call this API:

  • aura-ai-services:messaging:write: Permission to send Generative / RAG and feedback messages to Aura.
  • aura-ai-services:nlp-messaging:write: Permission to send NLP as a Service messages to Aura.
    
    

• Access from Kernel to aura-gateway-api will be done by APIKey. It is necessary to create this APIKey in each environment following these instructions Generate an APIKey.
  
  

• Request Kernel team to configure in the corresponding Kernel environment this API Aura AI Services.

  • For that, the following settings are needed:

    • URL: https://{{aura-services-environment}}.auracognitive.com/aura-services/v2/aiservices/

    • Authorization header: APIKEY {{api-key}}

      Where:

      • {{aura-services-environment}} should look like svc-[country]-[environment], for instance svc-es-pre
      • {{api-key}} is a specific APIKey created for Kernel to access this endpoint. This APIKey must be requested to the team in charge of operating the corresponding Aura environment:
        • Aura Global team for development and staging environments
        • GES for certifications, pre-production and production environments
          
          

• This process must be executed in each Kernel deployment.