Skip to content

This skill acts as a gateway between Mycroft AI core instance and Mycroft REST API.

License

Notifications You must be signed in to change notification settings

smartgic/skill-rest-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License: MIT contributions welcome Skill: MIT Discord

REST API

Acts as a gateway between Open Voice OS and OVOS REST API.

About

The OVOS REST API allows an interaction with a Mycroft AI core instance without to log into it or without any voice interaction. The communication between this skill and the REST API uses an autentication token to enforce the security.

API flow

Examples

No voice interaction because the skill will mostly interact with an API.

Installation

Make sure to be within the Open Voice OS virtualenv before running the pip command.

. ~/.venvs/ovos/bin/activate.sh
pip3 install git+https://github.com/smartgic/skill-rest-api.git

Configuration

This skill utilizes the ~/.config/mycroft/skills/skill-rest-api.smartgic/settings.json file which allows you to configure this skill.

The API key should be retrieved from the OVOS REST API .env file.

SECRET="557622baf088a6a4bee012c90f9097a23ec23ad6ce20eae9"
WS_HOST="10.12.50.20"
WS_PORT="8181"
API_KEY="bg80e453765a80d825988fe70c2c9b85d2a5494e720cecet"
USERS_DB="/users.json"

Credits

Category

System

Tags

#api #restapi #websocket #bus