Aura – api-definition

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-generative-api plugin

Description of the aura-generative-api plugin

Introduction

The aura-generative-api plugin manages the endpoints for the communication with atria-model-gateway.

Consumes components (IOC)

Name	Type	Description
generativeProcessService	PluginType.Service	Send data to model-gw and process the response
applicationConfiguration	PluginType.Service	Configuration of applications

Provides components (IOC)

Name	Type	Description
generativeApi	PluginType.API	Endpoints for the communication with generative APIs

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

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-generative-process-service plugin

Description of the aura-generative-process-service plugin

Introduction

The aura-generative-process-service plugin manages the communication with atria-model-gateway to allow applications to communicate with LLMs.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
applicationConfiguration	PluginType.Service	Configuration of applications

Provides components (IOC)

Name	Type	Description
generativeProcessService	PluginType.Service	Send data to model-gw and process the response

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

configuration-service plugin

Description of the configuration-service plugin

Introduction

The configuration-service plugin manages the configuration of agents.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager

Provides components (IOC)

Name	Type	Description
agentsConfiguration	PluginType.Service	Agents configuration

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

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

redis-connector-service plugin

Description of the redis-connector-service plugin

Introduction

The redis-connector-service plugin manages requests to Redis.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager

Provides components (IOC)

Name	Type	Description
redisConnector	PluginType.Service	Redis connector

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

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-feedback-api plugin

Description of the aura-feedback-api plugin

Introduction

The aura-feedback-api plugin manages the communication with atria-model-gateway to provide feedback about the Generative and RAG services behavior.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
applicationConfiguration	PluginType.Service	Configuration of applications

Provides components (IOC)

Name	Type	Description
feedbackApi	PluginType.API	Endpoints for the communication with feedback endpoint

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

aura-agents-api plugin

Description of the aura-agents-api plugin

Introduction

The aura-agents-api plugin manages the endpoints for the communication with the agents-manager.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
applicationConfiguration	PluginType.Service	Configuration of applications
agentsConfiguration	PluginType.Service	Configuration of agents

Provides components (IOC)

Name	Type	Description
agentsApi	PluginType.API	Endpoints for the communication with agents APIs
agentsManagerClient	PluginType.Service	Client of agents-manager

Docs:

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

aura-operations-api plugin

Description of the aura-operations-api plugin

Introduction

The aura-operations-api plugin manages the endpoints for operations related to Aura.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager

Provides components (IOC)

Name	Type	Description
operationsApi	PluginType.API	Endpoints for the communication with operations APIs
configWatcherOperationsClient	PluginType.Service	Client to make requests to the config-watcher

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