Typescript SDK

npm install supermemory

import supermemory from 'supermemory';

const client = new supermemory({
  apiKey: process.env['SUPERMEMORY_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const response = await client.search.execute({ q: 'documents related to python' });

  console.debug(response.results);
}

main();

import supermemory from 'supermemory';

const client = new supermemory({
  apiKey: process.env['SUPERMEMORY_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const params: supermemory.MemoryAddParams = {
    content: 'This is a detailed article about machine learning concepts...',
  };
  const response: supermemory.MemoryAddResponse = await client.memories.add(params);
}

main();

import fs from 'fs';
import supermemory, { toFile } from 'supermemory';

const client = new supermemory();

// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
await client.memories.uploadFile({ file: fs.createReadStream('/path/to/file') });

// Or if you have the web `File` API you can pass a `File` instance:
await client.memories.uploadFile({ file: new File(['my bytes'], 'file') });

// You can also pass a `fetch` `Response`:
await client.memories.uploadFile({ file: await fetch('https://somesite/file') });

// Finally, if none of the above are convenient, you can use our `toFile` helper:
await client.memories.uploadFile({ file: await toFile(Buffer.from('my bytes'), 'file') });
await client.memories.uploadFile({ file: await toFile(new Uint8Array([0, 1, 2]), 'file') });

async function main() {
  const response = await client.memories
    .add({ content: 'This is a detailed article about machine learning concepts...' })
    .catch(async (err) => {
      if (err instanceof supermemory.APIError) {
        console.debug(err.status); // 400
        console.debug(err.name); // BadRequestError
        console.debug(err.headers); // {server: 'nginx', ...}
      } else {
        throw err;
      }
    });
}

main();

// Configure the default for all requests:
const client = new supermemory({
  maxRetries: 0, // default is 2
});

// Or, configure per-request:
await client.memories.add({ content: 'This is a detailed article about machine learning concepts...' }, {
  maxRetries: 5,
});

// Configure the default for all requests:
const client = new supermemory({
  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});

// Override per-request:
await client.memories.add({ content: 'This is a detailed article about machine learning concepts...' }, {
  timeout: 5 * 1000,
});

const client = new supermemory();

const response = await client.memories
  .add({ content: 'This is a detailed article about machine learning concepts...' })
  .asResponse();
console.debug(response.headers.get('X-My-Header'));
console.debug(response.statusText); // access the underlying Response object

const { data: response, response: raw } = await client.memories
  .add({ content: 'This is a detailed article about machine learning concepts...' })
  .withResponse();
console.debug(raw.headers.get('X-My-Header'));
console.debug(response.id);

import supermemory from 'supermemory';

const client = new supermemory({
  logLevel: 'debug', // Show all log messages
});

import supermemory from 'supermemory';
import pino from 'pino';

const logger = pino();

const client = new supermemory({
  logger: logger.child({ name: 'supermemory' }),
  logLevel: 'debug', // Send all messages to pino, allowing it to filter
});

await client.post('/some/path', {
  body: { some_prop: 'foo' },
  query: { some_query_arg: 'bar' },
});

client.foo.create({
  foo: 'my_param',
  bar: 12,
  // @ts-expect-error baz is not yet public
  baz: 'undocumented option',
});

import fetch from 'my-fetch';

globalThis.fetch = fetch;

import supermemory from 'supermemory';
import fetch from 'my-fetch';

const client = new supermemory({ fetch });

import supermemory from 'supermemory';

const client = new supermemory({
  fetchOptions: {
    // `RequestInit` options
  },
});

import supermemory from 'supermemory';
import * as undici from 'undici';

const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
const client = new supermemory({
  fetchOptions: {
    dispatcher: proxyAgent,
  },
});

import supermemory from 'supermemory';

const client = new supermemory({
  fetchOptions: {
    proxy: 'http://localhost:8888',
  },
});

import supermemory from 'npm:supermemory';

const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const client = new supermemory({
  fetchOptions: {
    client: httpClient,
  },
});