We'll do our best to respond as quickly as we can. Please adhere to the established coding conventions within the project and submit changes using pull requests.Īdditional information for developers is here: developers.md Bugs / Support / Troubleshootingįor bugs with the API client, command-line utility, or the HTTP API, please file tickets using GitHub Issues on this repo. We welcome contributions to this project. Note: the jq tool is used in the bash sample for parsing JSON data. See the directory samples for a few simple samples of using the node API, and the CLI in a bash script. If you've created an API client in a language other than JavaScript, please let us know at and we will link to it here. In order to use the HTTP API directly you must specify the x-api-key header with the value of your API key. If making HTTP requests directly to the Paperspace API endpoints use the following address for each request: Authenticating to the Paperspace API Address for the Paperspace API HTTP endpoints If you'd prefer to build your own client instead of using the Paperspace-Node library, you can use the Paperspace API HTTP endpoints directly, as described in the API documentation. That is, the first argument is parameters object, and the second is a error-first callback function.įor information on all the methods available, see the API documentation. Authenticationįor authenticated requests, the Paperspace-Node module will look for an api key:Īn environment variable: PAPERSPACE_API_KEY. You can interact with CORE API in two ways: by using an HTTP client of your choice and the Paperspace API HTTP endpoints or programmatically from within a Javascript Node.js application. You'll use the API keys generated here to authenticate your requests. Login to your Paperspace console, visit your team settings page, locate the API section, and follow the instructions to create a new API key. You can create an API key from within your Paperspace console under the API section. Obtain an API key via your Paperspace Console There is currently only one way to create an API key: from within the section of your Paperspace console. Your API key allows you to access the Paperspace CORE API via conventional HTTP requests or from within apps that you develop. Once you have created a Paperspace Account you will need to obtain a API key. You'll use this account to obtain a Paperspace API key.Īfter creating your Paperspace account check your email to confirm your account before logging in. Setup a Paperspace Accountīefore you can use this tool, you'll need a Paperspace account. If you want to make it available only within an individual Node.js project, you can install it for use only in the current directory by omitting the -g flag. We recommend installing the paperspace-node package globally so that the paperspace command will be available on your command line everywhere on your system.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |