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:

[
  {
    "item_id": "aeb2052b-e60b-4bba-b02f-a599f2465787",
    "idx": 140,
    "content": "15\nThe Special Theory of Relativity\n15-1 The principle of relativity\nFor over 200 years the equations of motion enunciated by Newton were believed\nto describe nature correctly, and the first time that an error in these laws was\ndiscovered, the way to correct it was also discovered. Both the ...",
    "uri": "",
    "kind": "file",
    "file_name": "the-feynman-lectures-on-physics-volume-i-mainly-mechanics-radiation-and-heat.pdf",
    "file_type": "application/pdf",
    "time_added": "2024-10-08T18:32:29.569418Z",
    "time_authored": "2015-04-27T18:39:05Z",
    "score": 0.99142253,
    "metadata": {
      "creator": "Matthew",
      "time_created": "2013-05-04T08:54:12Z",
      "time_modified": "2015-04-27T18:39:05Z"
    }
  }, ...
]

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.

1

Open the dashboard

Go to the dashboard.

2

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.

3

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.