aboutsummaryrefslogtreecommitdiff
path: root/apps/docs/quickstart.mdx
blob: b2b4db753aa19f757169b9ad60bdc25b2cb0752b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
title: "Getting Started"
description: "Start using Supermemory API in under 5 minutes"
---

To use the Supermemory API, you'll need:

1. An API key (get one by signing up at https://dev.supermemory.ai )
2. Basic understanding of REST APIs
3. A tool to make HTTP requests (like curl, Postman, or your favorite programming language)

<AccordionGroup>
  <Accordion title="Getting Your API Key" icon="key">
    1. Login into https://dev.supermemory.ai and create an organization
    2. Create an api key, copy and save it securely.

    ![image.png](/image.png)

    Keep your API key secure and never share it publicly. You'll need this key for authenticating all API requests.
  </Accordion>
</AccordionGroup>

## Base URL

All API requests should be made to:

```
https://v2.api.supermemory.ai
```

## Add your first memory

```bash
curl -X POST https://v2.api.supermemory.ai/add \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "This is the content of my first memory."}'
```

This will add a new memory to your Supermemory account.

Try it out in the [API Playground](/api-reference/endpoints/add-new-content)

## Search your memories

```bash
curl -X GET https://v2.api.supermemory.ai/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q": "This is the content of my first memory."}'
```

Try it out in the [API Playground](/api-reference/endpoints/search-content)

That's it\\! You've now added your first memory and searched for it.