Getting Started

Install NeuralSpace using pip

If you wish to use the NeuralSpace CLI, install from pip using the following command

pip install neuralspace

ADVANCED: ACCESS YOUR PRIVATE CLOUD THROUGH THE CLI

After installing neuralspace CLI, set this environment variable if you have a private cloud.

export NEURALSPACE_URL="URL TO YOUR PRIVATE CLOUD"

Login

CLI

To use the CLI, you will first have to log in into your NeuralSpace account. This saves your encrypted credentials locally and reuses it for all other commands.

Prerequisites

• Python3.7+
• Git
• An activated account on the NeuralSpace Platform
• A linux system

neuralspace log in

This will prompt you to enter the email and hide protected password.

API

To use our APIs you will need an authorization token. Using the log in API you can get your access token.

Login

Skip this if you already have your authorization token

Curl

curl --location --request POST 'https://platform.neuralspace.ai/api/auth/login' \
--header 'Accept: application/json, text/plain, */*' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "email": "YOUR-NEURALSPACE-EMAIL-ID",
    "password": "YOUR-NEURALSPACE-PASSWORD"
}'

The response would look something like this.

{
    "success": true,
    "message": "Login successful",
    "timestamp": ...,
    "data": {
        "user": {
            "name": "YOUR-NAME",
            "email": "YOUR-NEURALSPACE-EMAIL-ID",
            "apikey": "YOUR-API-KEY",
            "role": "provider"
        },
        "auth": "YOUR-AUTHORIZATION-TOKEN",
        "apps": [
            "..."
        ]
    }
}

Store your authorization token in a variable.

AUTHORIZATION_TOKEN="YOUR-AUTHORIZATION-TOKEN"

Install App

CLI

To start using an app, you will first have to install it.

neuralspace install-app -n nlu

The above command installs nlu into your account. Replace nlu with any App that you wish to install.

API

Use the following API to install an App into your account.

Curl

curl --location --request POST 'https://platform.neuralspace.ai/api/app/install' \
--header 'Accept: application/json, text/plain, */*' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header "Authorization: ${AUTHORIZATION_TOKEN}" \
--data-raw '{
    "appType":"nlu"
}'

The above request installs nlu into your account. Replace appType with any app that you wish to install.

List Apps

CLI

You can also view all the Apps that have been installed into your account using the CLI.

neuralspace list-Apps