mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-05-17 03:56:18 +00:00
75 lines
2 KiB
Text
75 lines
2 KiB
Text
---
|
|
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 [supermemory.ai](https://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 icon="key" title="Getting Your API Key">
|
|
1. Login into [supermemory.ai](https://supermemory.ai) and click on the "Add Memory" button
|
|
|
|
|
|
|
|
2. Click on "Integrations" in the navigation menu
|
|
|
|
|
|
|
|
3. You'll see your API key, you can copy it by clicking on the copy button
|
|
|
|
|
|
|
|
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://api.supermemory.ai/v1
|
|
```
|
|
|
|
## Add your first memory
|
|
|
|
```bash
|
|
curl -X POST https://api.supermemory.ai/v1/add \
|
|
-H "Authorization: Bearer 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://api.supermemory.ai/v1/search \
|
|
-H "Authorization: Bearer YOUR_API_KEY" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"query": "This is the content of my first memory."}'
|
|
```
|
|
|
|
Try it out in the [API Playground](/api-reference/endpoints/search-content)
|
|
|
|
## Get your memories
|
|
|
|
```bash
|
|
curl -X GET https://api.supermemory.ai/v1/memories \
|
|
-H "Authorization: Bearer YOUR_API_KEY" \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
This will return a list of all your memories.
|
|
|
|
Try it out in the [API Playground](/api-reference/endpoints/list-memories)
|
|
|
|
That's it! You've now added your first memory and searched for it.
|