Aura – api

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agents Manager API

Definition of the complete API in agents-manager

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura authentication API definition

Description of Aura Authentication API swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura bridge API

Description of Aura bridge API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API definition

Description of Aura configuration API swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Gateway API

Definition of the complete API in aura-gateway-api

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Bridge APIs for AuraLine channel

Description of aura-bridge API swaggers for AuraLine channel

Introduction

Currently, aura-bridge counts on the following API swaggers for the AuraLine channel:

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

AuraLine Channel Callback API

Description of AuraLine Channel Callback API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

AuraLine Conversation API

Description of AuraLine Conversation API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

AuraLine Message API

Description of AuraLine Message API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Publish an API in Kernel

Guidelines for the publication of 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.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agent Deployment API

This document provides the API definition for the agent-deployment plugin, which is responsible for managing the deployment of agents within the agents-manager.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agents Manager Development API

Description of Agents Manager Development API. Only available in development environments.

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API core definition

Description of Aura configuration API core swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Gateway Core API

Definition of the core API in aura-gateway-api

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Authentication API endpoints

Description of Aura Authentication API endpoints, categorized by how they can be accessed or by their usage

Endpoints by access

aura-authentication-api counts on:

Internal endpoints: they are only allowed to APIKeys generated for aura-groot/aura-bot.
Public endpoints: they are publicly open and all valid APIKeys for the current environment can access them.
Endpoints published in Kernel, i.e. they are publicly open but they are only allowed to APIKeys generated for Kernel. Read Aura Services API published in Kernel for further information.

The following section explains every endpoint, showing whether it is internal, public, Kernel or a mix.

Endpoints by usage

Register new users

GET /users/aura-id: Endpoint published in Kernel, used by Aura Channels that handle their own authentication mechanisms. They must call this endpoint to get a valid authenticated Aura user to start a conversation. This method retrieves the already existing user if the data sent exists or create a new user with the data, otherwise. Authorized by APIKey.
GET /users/aura-id/{auraId}: Internal method used only by aura-groot/aura-bot in order to create a new user when the auraId is based on the external service authentication, such as for WhatsApp users. Authorized by APIKey.
GET /users/auraid/integrated: Endpoint used as callback during non-integrated authentication request. This endpoint is used by Aura clients account linking process without integrated authentication. It is called by Kernel after creating the authentication session, to add the Aura user record. No authorization header. Validation done by a ciphered query param.

Remove users

DELETE /admin/users/phone-numbers/{phone_number}: Endpoint published in Kernel, used by OB administrators to fulfill GDPR and remove users by phone number that are not longer Telefonica’s customers. Authorized by APIKey.
GET /users/auraid/integrated/logout: Public endpoint used as callback during non-integrated logout request. This endpoint is used by Aura clients account unlinking process without integrated authentication. It is called by Kernel after removing the authentication session, to remove the Aura user record. No authorization header. Validation done by a ciphered queryparam.
DELETE /users/{auraId}: Internal and also published in Kernel endpoint used by aura-bot and the non-integrated channels, to remove the information of an already logged in Aura user. Authorized by APIKey.

Gather users’ information

GET /users/{auraId}: Internal endpoint used by aura-groot/aura-bot to get and validate the information of an already logged in Aura user. Authorized by APIKey.
GET /users/aura-id-global/{aura_id_global}: Endpoint published in Kernel, used to get the last valid auraId for the channel, generated for the given auraIdGlobal. Authorized by APIKey.

Retrieve a valid Direct Line token from the current Aura Bot instance and start a conversation with it

GET /token: Public endpoint used by Aura channels accessing by Direct Line, to get a valid Direct Line-Token to access the bot in the selected environment. This endpoint just returns the token and its expiration time. Authorized by APIKey.
GET /token/wss: Public endpoint used by Aura channels accessing by Direct Line, to get a valid Direct Line-Token to access the bot in the selected environment. This endpoint returns the token, the websocket stream URL, the expiration time and some other fields returned by Direct Line API. Authorized by APIKey.

Public key (no APIKey)

GET /openid/issuer/.well-known/openid-configuration: Public endpoint to get the public key URL of aura-groot/aura-bot.
GET /openid/jwk: Public endpoint to get the public key configuration of aura-groot/aura-bot. Used to validate the requests signed with aura-groot/aura-bot private key.

Monitoring methods

GET /healthz: Internal health check endpoint to validate the server status by the Kubernetes cluster. No authorization header needed.
GET /ping: Endpoint published in Kernel to validate the server status.

Configuration method

GET /config: Public endpoint to return the name of the Azure Storage subdomain.

Metrics method

GET /metrics: Public endpoint where Prometheus requests the metrics.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Terms and Conditions API

Description of Aura Terms and Conditions API

Introduction

Temporary implementation of the Kernel TermsAndConditions API.

This is an internal, privileged API that allows Aura to save the user’s acceptation. As this API is not inside any secured deployment, an x-api-key header should be sent in every request.

This service is available in all the deployments with services needing Terms and Conditions handling, such as WhatsApp

Acceptance criteria

There may be different versions for the service T&C.
Only acceptations, not revocations, should be stored.
There should be a way to allow deleting all acceptations for a user.

Database schema

Terms and Conditions database contains the services collection with the following structure:

API

Create an acceptation for a service version T&C POST /v0/users/:user_id/services

POST /v0/users/9a47b037-825f-4ae7-bf55-6290efd5d036/services
Content-Type: application/json
x-api-key: 58e76225-d275-495b-a232-fdf3364ac277
{
	"version": "1",
	"name": "aura"
}

HTTP/1.1 201 Created
Content-Type: application/json
{
  "user_id": "9a47b037-825f-4ae7-bf55-6290efd5d036",
  "name": "aura",
  "version": "1",
  "status": "accepted",
  "created_at": "2019-08-08T15:19:48.259Z"
}

List user acceptations GET /v0/users/:user_id/services

GET /v0/users/9a47b037-825f-4ae7-bf55-6290efd5d036/services
x-api-key: 58e76225-d275-495b-a232-fdf3364ac277

HTTP/1.1 200 OK
Content-Type: application/json
[
  {
    "user_id": "9a47b037-825f-4ae7-bf55-6290efd5d036",
    "name": "aura",
    "version": "1",
    "status": "accepted",
    "created_at": "2019-08-08T15:19:48.259Z"
  }
]

get specific user acceptation GET /v0/users/:user_id/services/:name/:version

GET /v0/users/9a47b037-825f-4ae7-bf55-6290efd5d036/services/aura/1
x-api-key: 58e76225-d275-495b-a232-fdf3364ac277

HTTP/1.1 200 OK
Content-Type: application/json
{
  "user_id": "9a47b037-825f-4ae7-bf55-6290efd5d036",
  "name": "aura",
  "version": "1",
  "status": "accepted",
  "created_at": "2019-08-08T15:19:48.259Z"
}

delete all user acceptations DELETE /v0/users/:user_id/services

DELETE /v0/users/9a47b037-825f-4ae7-bf55-6290efd5d036/services
x-api-key: 58e76225-d275-495b-a232-fdf3364ac277

HTTP/1.1 204 No Content

Create an entry with custom status for a service version T&C POST /v0/users/:user_id/services/:status

POST /v0/users/9a47b037-825f-4ae7-bf55-6290efd5d036/services/pending
Content-Type: application/json
x-api-key: 58e76225-d275-495b-a232-fdf3364ac277
{
	"version": "1",
	"name": "aura"
}

HTTP/1.1 201 Created
Content-Type: application/json
{
  "user_id": "9a47b037-825f-4ae7-bf55-6290efd5d036",
  "name": "aura",
  "version": "1",
  "status": "pending",
  "created_at": "2019-08-08T15:19:48.259Z"
}

Update an entry with custom status for a service version T&C PUT /v0/users/:user_id/services/:status

PUT /v0/users/9a47b037-825f-4ae7-bf55-6290efd5d036/services/newStatus
Content-Type: application/json
x-api-key: 58e76225-d275-495b-a232-fdf3364ac277
{
	"version": "1",
	"name": "aura"
}

HTTP/1.1 201 Created
Content-Type: application/json
{
    "n": 1,
    "nModified": 1,
    "ok": 1
}

Metrics

prometheus

GET /metrics
HTTP/1.1 200 OK

...txt...

liveness prove

GET /ping
HTTP/1.1 200 OK
Content-Type: application/json

{
  "timestamp": 1567693845103,
  "uptime": 7026,
  "service": {
    "name": "tac",
    "version": "1.0.5"
  }
}

Development

docker-compose up

To clean database and start from scratch

docker-compose down -v

Configuration

The configuration comes from environment variables.

# the mongodb uri, including user/password and ssl configuration
export TAC_MONGODB_URI=mongodb://db:27017/tac
# API key that should be sent in every request in the `x-api-key` header
export TAC_APIKEY=58e76225-d275-495b-a232-fdf3364ac277

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agents Manager Dispatcher API

Description of Agents Manager Dispatcher API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Atria Model Gateway API definition

Description of Atria Model Gateway configuration API swagger

This is an internal ATRIA API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Agents API

Description of Aura Agents API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API Engine Filter definition

Description of Aura configuration API Engine Filter swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API Preset definition

Description of Aura configuration API Preset swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API Routing Filter definition

Description of Aura configuration API Routing Filter swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Dapr PubSub API

Description of Dapr PubSub API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Postman collections

In this section, you will find all the Postman collections generated in order to test APIs in Aura

Introduction

Postman is an application used for API testing. It is an HTTP client that tests HTTP requests, using a graphical user interface, through which we obtain different types of responses that need to be subsequently validated.

Postman collections are a tidy way to group your requests together so you can save, reuse, and share them with others.

The current document includes the Postman collections generated by Aura Platform Team:

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API TV Section definition

Description of Aura configuration API TV Section swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Generative API

Description of Aura Generative API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API Agent definition

Description of Aura configuration API Agent swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API Agent base definition

Description of Aura configuration API Agent base swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration API Suggestion definition

Description of Aura configuration API Suggestion swagger

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura NLP resolution API

Description of Aura NLP Resolution API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Change the environment encryption key

Description of the process to change the encryption key without service loss

Introduction

This document describes how to change the encryption key of the Aura environments without service loss. The encryption key in Aura has three main usages:

Generation and validation of the service APIKeys.
Encryption of the secrets stored in the channels configuration settings.
Encryption of temporary params shared with other systems to validate an incoming request. For instance, when authenticating a user using the “Redirect authentication” of Kernel IdP, to be able to validate the incoming request with the user data in the authentication callback, via the state field, which is encrypted by Aura Bot and sent as query param to the authentication callback of Aura.

The mechanism proposed allows to validate APIKeys encrypted with several keys, whilst the servers use just the active encryption key for the rest of the functionalities.

Further information regarding how to configure the new encryption in the installer can be found in the deployment documentation.

Requirements

Docker and python3 installed in your local machine
- Also Nodejs20 if want to try the snippet to generate the encryption keys.
Access to the Aura installer
Access to the config.yml of your environment

Procedure

⚠️ It is important to do this change only during the installation of a new release of Aura, to avoid problems in the encryption of the channels collection and to let the installer generate automatically all the internal APIKeys.

Generate a 32 character encryption key. The length is mandatory because of the encryption algorithm being used. The following snippet contains an example of how to generate it using Nodejs:

const crypto = require('crypto');
const key = crypto.randomBytes(16).toString('hex');
console.log(key);

Encrypt it using ansible-vault:

ansible-vault encrypt_string 'old-encryptionkey,new-encryptionkey' --name 'aura_encryption_key'
New Vault password: 
Confirm New Vault password: 
Encryption successful
aura_encryption_key: !vault |
          $ANSIBLE_VAULT;1.1;AES256
          62393736616536336262613333313866366365396361643930653535633564636430343530303637
          3866643931653739343164303662376439316630633538620a663031306265613162353633323565
          33376662626162663431616132353436366431383064663131643363653636346336343433303637
          3666333534656439390a656132306236336337383761323166666430633463303461316561363632
          65396530323635323363316362343437623065353232339343731643031653961336137343664366
          162386564636561313532633662383366383364653362663530653563623362303164653137653039
          663430356237366439663238346130656432303737

Configure it in the config.yml of your environment:

vim config.yml
...
aura_encryption_key: !vault |
          $ANSIBLE_VAULT;1.1;AES256
          62393736616536336262613333313866366365396361643930653535633564636430343530303637
          3866643931653739343164303662376439316630633538620a663031306265613162353633323565
          33376662626162663431616132353436366431383064663131643363653636346336343433303637
          3666333534656439390a656132306236336337383761323166666430633463303461316561363632
          65396530323635323363316362343437623065353232339343731643031653961336137343664366
          162386564636561313532633662383366383364653362663530653563623362303164653137653039
          663430356237366439663238346130656432303737
...

Now, the installer can be launched. The default encryption key is going to be new-encryptionkey.
- The installer will generate all the internally used APIKeys, such as the one provided in the configuration of the services stored in the environment variable as AURA_AUTHORIZATION_HEADER.
Generate the new APIKeys for all the consumers of Aura’s APIs, using the tool of the installer to do it, following the instructions in generate APIKey section, the APIKeys are going to be created directly with the default one.
The APIKeys to be created depend on the environment, but take into account the following notes to update them all:
- The APIKey is used by all the channels accessing Aura via DirectLine, a new one per channel should be generated.
- The APIKey is used in the following webhooks or Aura APIs configured in Telefónica Kernel:
  - WhatsApp webhooks
  - Deployment of aura-services API
  - Deployment of aura-aiservices API
Once all the channels and Kernel configurations are changed to use the brand-new APIKeys, the environment configuration can be changed to count only with the default one.
To do the change from release to release, at least the encryption key of the latest deployment and the new one should be configured.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Generate an APIKey in Aura

Methods for the generation of an APIKey in Aura

Introduction

All Aura’s public APIs are protected using an APIKey.

The generation of an APIKey can be done using two alternative processes:

Generate an APIKey from Aura installer aurak8s
Follow the instructions in the document Create Aura APIKeys
Generate an APIKey using the aura-api-key-generator utility
- aura-api-key-generator is an Aura utility that generates encrypted APIKeys with a JSON model that will be used to validate the access to Aura’s public APIs.
- It is executed with the configuration of the chosen environment. This utility must be executed by the Operations Team and the generated APIKey must only be shared with the team involved in the integration of the corresponding API client.
- The guidelines are included in the following sections.

Generate an APIKey using the aura-api-key-generator utility

These guidelines correspond to the process that uses the aura-api-key-generator utility as a Docker image.

Prerequisites

Docker 23.0.5 or higher
Access to auraregistry.azurecr.io private docker registry.

The ENCRYPTION_KEY of the environment where the APIKey will be used:

kubectl installed in your local host.
curl installed in your local host.
jq installed in your local host.

To obtain the ENCRYPTION_KEY, just execute the following command:

# substitute {{aura-environment}} with the environment you're configuring
export AURA_ENVIRONMENT={{aura-environment}}

$ kubectl -n $AURA_ENVIRONMENT get secret aura-bot -o json | jq -r ".data.AURA_ENCRYPTION_KEY|@base64d"

YOUR-ENCRYPTION-KEY

Run the tool

Download the Docker image and run the tool by executing the following command:

# Substitute {{aura-encryption-key}} with the ENCRYPTION_KEY obtained in the previous step
$ docker run -e AURA_ENCRYPTION_KEY={{aura-encryption-key}} auraregistry.azurecr.io/aura/aura-api-key-generator:1.0.0 -v 8.3.0 -s aura-services -a kernel -m rw

Usage

> @telefonica/aura-api-key-generator@1.0.0 start
> node lib/index.js --help

process.env.CONFIG_FILE (undefined) not found or not configured, using only process.env

Usage: index -s aura-services:token -e pre -a kernel -v 8.3.0 -m rw

Utility to generate API Key to access the APIs of Aura.  Version: 1.0.0.

Options:
  -V, --version                     Output the version number
  -i, --identifier [identifier]     Unique identifier of the APIKey. Format UUID. If not provided, it will be autogenerated
  -s, --scope [scope]               Comma-separated list of strings containing the API path where this APIKey will be used. Possible values: "aura-services", "aura-services:users,aura-services:token", "aura-services:whatsapp", etc. (By default: "aura-services")
  -e, --enviroment <enviroment>     Environment where the APIKey will be used. Possible values: dev, stg, pre, pro (Choices: "dev", "stg", "pre", "pro". By default: "pro")
  -a, --authorised <client>         Name of the client that will use the APIKey. Usually one of kernel, novum, mh, mp, stb, la, etc. (By default: "kernel")
  -v, --aura-version <auraVersion>  Minimum Aura Platform version to use this APIKey. It should contain the full version of Aura. Example: 8.3.0 (default: "8.3.0")
  -m, --mode <mode>                 Type of access to the API. Possible values: r, w, rw (Choices: "r", "w", "rw". By default: "r")
  -h, --help                        Display help for command

Scope

All public Aura’s APIs are in the aura-services scope, so any APIKey generated with this scope will have access to all Aura’s APIs. But the idea is to use always the minimum scope valid for the specific usage of the client.

For example:

For those clients that are Aura channels and need to get a Direct Line token from Aura, the scope must be aura-services:token.
To configure the WhatsApp webhooks of aura-bridge in Kernel, the scope must be aura-services:whatsapp.
To configure the access from Kernel to aura-services API, the scope must be aura-services:users.
To configure the access from Kernel to aura-gateway-api in aura-services API, the scope must be aura-ai-services:messaging:write or aura-ai-services:nlp-messaging:write.

Environment

As the specific environment is configured via the ENCRYPTION_KEY, the environment parameter is only used to generate the APIKey with the correct environment name.

The environment name is used to validate the APIKey when it is used to access an API. It only contains the type of the environment: dev, stg, pre or pro.

Authorized

It should contain a human-readable name of the client that will use the APIKey. The usual values are: kernel, novum, mh, mp, stb, la, metaverse.

API Version

It contains the major version of the Aura API that the APIKey will be used.

For example, if the APIKey will be used to access the aura-services API, the API version must be 1. It must be coherent with the version of the API published in Aura’s API documentation.

Mode

It indicates the type of access to the API:

r: read-only access, it allows to access the API to execute GET operations.
w: write-only access, it allows to access the API to execute POST, PUT and DELETE operations.
rw: read-write access, it allows to access the API to execute GET, POST, PUT and DELETE operations.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

API definition for Agents Manager

Description of API swaggers for agents-manager component

APIs index

Agents Manager API
Agents Manager Development API
Only available in development environments.
Agents Manager Dispatcher API
Dapr PubSub API

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

API definition for Aura Gateway API

Description of API swaggers for aura-gateway-api component

APIs index

Aura Gateway API
Definition of the complete API in aura-gateway-api
Aura Gateway Core API
Definition of the core API in aura-gateway-api that handle its operations
Aura Gateway Agents API
This API is exposed in Kernel to handle agents services: https://developers.baikalplatform.com/apis/aura-aiservices/
Aura Generative API
This API is exposed in Kernel to handle Generative and RAG services: https://developers.baikalplatform.com/apis/aura-aiservices/
Aura NLP Resolution API
This API is exposed in Kernel to handle NLP as a Service: https://developers.baikalplatform.com/apis/aura-aiservices/
Aura Feedback API
This API is exposed in Kernel to provide feedback about the behavior of Generative and RAG services: https://developers.baikalplatform.com/apis/aura-aiservices/
Aura Gateway Update-Me API
Aura Gateway Development API
Only available in development environments.
Dapr PubSub API
Aura Operations API
API that include a set of endpoints related to operations over Aura.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

API definition for Aura Server Common

Description of API Swagger for aura-server-common

APIs index

Dapr PubSub API

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Feedback API

Description of Aura Feedback API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Gateway Development API

Description of Aura Gateway Development API. Only available in development environments.

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Operations API

Description of Aura Operations API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Agents Server API definition

Description of Agents Server configuration API swagger

This is an internal AURA API.

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Authentication API definition

Definition of APIs in aura-authentication-api component

Introduction

This section includes the API definition files that affects to the authentication processes in Aura:

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Bridge APIs definition

Description of API swaggers for Aura bridge

Introduction

This section includes the OpenAPI definition files of the APIs of Aura. The folder contains the API of Aura and the partial published in Kernel.

The following APIs are available in aura-bridge:

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Configuration APIs definition

Description of API swaggers for Aura Configuration

Introduction

The following API swaggers are available in aura-configuration-api:

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura NLP API

Description of Aura NLP API

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Complex Logic API

Complex Logic Framework API swagger documentation, which is the main swagger for all CLF plugins

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura file manager API definition

Description of aura-file-manager API, microservice responsible for handling attached files storage and validations at channel level

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Release Train Manager API definition

Description of Release Train Manager API

This API is used to manage the release train process and stores both the configuration and state of all the main/hotfix/release/fasttrack branches handled by the release train manager, but also the status of the environments: component versions deployed, if any component has a new version waiting to be deployed, etc.

The API is used both from the release train manager and from the Jenkins CI jobs themselves.

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Services API published in Kernel

Description of Aura Authentication API endpoints published in Kernel

Introduction

As mentioned in the endpoints section, some of the endpoints of the aura-authentication-api are published in Kernel, while others are only for internal usage and others are published in Internet because they can be called by any other service, with the proper credentials.

This section is dedicated to those published in Kernel.

aura-services API definition in Kernel

The API published in Kernel is not strictly the same as the one published in aura-authentication-api. In the end, they represent the very same service, but the former needs to provide the layer of Kernel authentication.

The API definition can be found in Kernel developers site, where both the different versions deployed in every environment are presented.

How to consume this API

This is a regular Kernel API, so in order to consume it, just follow the same instructions as for the rest of Kernel APIs: consuming APIs.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Legacy Video API for Spain

Description of Legacy Video API.

Download swagger file

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

APIs documentation

Index of Aura Virtual Assistant and ATRIA APIs definition documents

APIs belong to both Aura Virtual Assistant and ATRIA

Introduction

An application programming interface (API) is a software interface that allows two applications to interact with each other without any user intervention. The API is composed of a collection of software functions and procedures for creation of applications to access features or data of a system, application or other service.

This section contains all the information related to Aura APIs, both the ones focused on internal use and others used by Aura’s channels and users to handle their conversations.

Most of our services lay on OpenAPI definitions v3.

APIs documentation is provided within the documentation for each specific component. Select the component of your interest and find the available APIs.

Select the specific API in the left menu and access to the corresponding section to find the API definition document.

Available APIs

Aura Virtual Assistant components	APIs
aura-bridge	aura-bridge APIs definition
Complex Logic Framework	Complex Logic Framework API definition
aura-authentication-api	aura-authentication-api API definition
aura-file-manager	aura-file-manager API definition

ATRIA components	APIs
aura-gateway-api	aura-gateway-api API definition
atria-model-gateway	atria-model-gateway API definition
Advanced Analytics Models (AAMs)	Advanced Analytics Models (AAMs) API definition

Cross components	APIs
Aura NLP	Aura NLP API definition
aura-configuration-api	aura-configuration-api API definition
Release Train Manager	Release Train Manager API definition