Skip to content
This repository was archived by the owner on Jun 6, 2023. It is now read-only.

Commit 84f50e7

Browse files
committed
updated README to add mention of samples/warn about possible changes to HTTP interfaces in the future
1 parent 4189b67 commit 84f50e7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ For information on all the methods available, see the [API documentation](https:
9191

9292
If you'd prefer to interact with our HTTP API directly, and roll your own client instead of using ours, our HTTP endpoints are also described in our [API documentation](https://paperspace.github.io/paperspace-sdk).
9393

94+
NOTE: the HTTP endpoints are subject to change in the future. We recommend using one of the programmatic APIs whenever possible to maintain forward compatibility.
95+
9496
### Address for HTTP endpoints
9597

9698
If making HTTP requests directly to the Paperspace HTTP endpoints use the following address for each request: `https://api.paperspace.io`
@@ -103,6 +105,10 @@ In order to use the HTTP API directly you must specify the `x-api-key` header wi
103105

104106
If you've created an API client in a language other than JavaScript, please [let us know](mailto:support@paperspace.com) and we will link to it here.
105107

108+
## Sample Apps
109+
110+
See the directory 'samples' for a few simple samples of using the node API, and the CLI in a bash script. Note: the [jq](https://stedolan.github.io/jq/) tool is used in the bash sample for parsing JSON data.
111+
106112
## Contributing
107113

108114
We welcome contributions to this project. Please adhere to the established coding conventions within the project and submit changes using pull requests.

0 commit comments

Comments
 (0)