Quickstart
Start with the basics
SID breaks down into two atomic units:
- Capsule: a collection of data
- Query: a way to access that data
Your first query
We’re going to create our first capsule later.
First, let’s query a capsule that already exists.
The capsule rocket-propelled-astroplex
contains Feynman’s lectures on physics volume I.
Here’s how you can query it (no API key required):
Pretty neat! The response should look something like this:
If you want to learn more about how a query works and what other parameters exist – like wishlist
and limit
,
please check out the API reference.
rocket-propelled-astroplex
is a public capsule, so no API key is required. If you want to query a private capsule, you’ll need to create an API key in the dashboard.Your first capsule
The easiest way to create a capsule is using the dashboard.
Please remember the ID of the capsule you created – you can always look it up in the dashboard.
It will look something like this: rocket-propelled-astroplex
.
Open the dashboard
Go to the dashboard.
Create a new capsule
Navigate to the “Home” tab and click on the “Create a new capsule” button. Remember the unique ID of the capsule you created.
Add data
Add some data to the capsule – like a file.
Create an API key
Navigate to the “API keys” tab and click on the “Create an API key” button.
Was this page helpful?