This feature is currently in early access and requires an invite. Click the "Request Early Access" Button to request access to Gradient Jobs and Notebooks.
Before you can use this tool, you'll need a Paperspace account. You'll use this account to obtain Paperspace API keys.
Your system will need Node.js v8+ installed. Check that you have a recent enough version by running
node -v in your terminal. Node.js comes bundled with
npm, the Node.js package management tool, which you'll use to install this package.
Option 1: Using pre-built binaries
Pre-built binaries are available for Windows, Mac, and Linux. These binaries enable you to run the paperspace-node command line tool without having to install Nodejs or any additional node modules. Be sure to add the directory where the binary is installed to your path.
Option 2: Install the package from npm
$ npm install -g paperspace-node
We recommend installing this globally is so the
paperspace command will be available on your command line everywhere on your system. If you only want to make it available within an individual Node.js project, you can install it locally by omitting the
-g flag. Be sure to also add this directory to your path.
02. Obtaining an API key
First, sign in to your Paperspace account. On the left of your home console, you should find an 'API' section. There, you'll find a form where you can create API keys. You'll use the API keys you generate here to authenticate your requests.