HTTPIE twinLab API

This is how one can use the twinLab API directly from the terminal using the HTTPie (brew install httpie) command line tool.

First, you need to set up the environment variables in the top-level .env file. You can copy the .env.example file as a template:

cp .env.example .env
open .env

If you are running locally, you need to set the TWINLAB_USERNAME and TWINLAB_SECRET variables. If you are running through RapidAPI then you need to set the TWINLAB_KEY and TWINLAB_HOST variables.

API

All the endpoints are wrapped into functions in the api.sh file. You can source this file directly from your terminal to use the functions:

source api.sh

The scripts in the examples folder demonstrate how to use these functions.

Admin commands

• Create a user
• View the database

User commands

Information

• View the stack versions

Profile

• View user profile

Dataset management

• List a user's datasets
• Upload a dataset
• Summarise a dataset
• Download a dataset
• Delete a dataset

Model management

• List a user's models
• Train a model
• View the training status of a model
• Summarise a model
• Use a trained model
• Delete a model