diff options
| author | Dhravya Shah <[email protected]> | 2025-03-23 20:18:37 -0700 |
|---|---|---|
| committer | Dhravya Shah <[email protected]> | 2025-03-23 20:18:37 -0700 |
| commit | f8dfb87604583a21840eaca2dd5542d77f5a8463 (patch) | |
| tree | 92502017e6661584e7692c2ad84d587c32136961 /apps/docs/quickstart.mdx | |
| parent | Merge branch 'main' of github.com:supermemoryai/supermemory (diff) | |
| download | supermemory-f8dfb87604583a21840eaca2dd5542d77f5a8463.tar.xz supermemory-f8dfb87604583a21840eaca2dd5542d77f5a8463.zip | |
Documentation edits made through Mintlify web editor
Diffstat (limited to 'apps/docs/quickstart.mdx')
| -rw-r--r-- | apps/docs/quickstart.mdx | 42 |
1 files changed, 11 insertions, 31 deletions
diff --git a/apps/docs/quickstart.mdx b/apps/docs/quickstart.mdx index 7b3c37d3..87dc84ec 100644 --- a/apps/docs/quickstart.mdx +++ b/apps/docs/quickstart.mdx @@ -5,26 +5,18 @@ 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)) +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 icon="key" title="Getting Your API Key"> - 1. Login into [supermemory.ai](https://supermemory.ai) and click on the "Add Memory" button + <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. -  - - 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> @@ -33,14 +25,14 @@ To use the Supermemory API, you'll need: All API requests should be made to: ``` -https://api.supermemory.ai/v1 +https://v2.api.supermemory.ai ``` ## Add your first memory ```bash -curl -X POST https://api.supermemory.ai/v1/add \ - -H "Authorization: Bearer YOUR_API_KEY" \ +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."}' ``` @@ -52,24 +44,12 @@ 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 \ +curl -X GET https://v2.api.supermemory.ai/search \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ - -d '{"query": "This is the content of my first memory."}' + -d '{"q": "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. +That's it\\! You've now added your first memory and searched for it.
\ No newline at end of file |