Skip to content
supermemory-new
Get started
API Reference
Settings

Get settings

client.settings.get(RequestOptionsoptions?): SettingGetResponse { chunkSize, excludeItems, filterPrompt, 16 more }
GET/v3/settings

Get settings for an organization

ReturnsExpand Collapse
SettingGetResponse { chunkSize, excludeItems, filterPrompt, 16 more }
chunkSize?: number | null
minimum-2147483648
maximum2147483647
excludeItems?: string | number | boolean | 2 more | null
One of the following:
string
number
boolean
Record<string, unknown>
Array<unknown>
filterPrompt?: string | null
githubClientId?: string | null
githubClientSecret?: string | null
githubCustomKeyEnabled?: boolean | null
googleDriveClientId?: string | null
googleDriveClientSecret?: string | null
googleDriveCustomKeyEnabled?: boolean | null
includeItems?: string | number | boolean | 2 more | null
One of the following:
string
number
boolean
Record<string, unknown>
Array<unknown>
notionClientId?: string | null
notionClientSecret?: string | null
notionCustomKeyEnabled?: boolean | null
onedriveClientId?: string | null
onedriveClientSecret?: string | null
onedriveCustomKeyEnabled?: boolean | null
profileBuckets?: Array<ProfileBucket>

Profile bucket definitions

key: string

Stable slug for the bucket, stored on each memory

minLength1
maxLength64
description?: string

What belongs in this bucket — used to guide the ingestion classifier.

maxLength2000
shouldLLMFilter?: boolean | null
workspacePrompt?: string | null
maxLength1500

Get settings

import Supermemory from 'supermemory';

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

const setting = await client.settings.get();

console.log(setting.chunkSize);
{
  "chunkSize": -2147483648,
  "excludeItems": "string",
  "filterPrompt": "filterPrompt",
  "githubClientId": "githubClientId",
  "githubClientSecret": "githubClientSecret",
  "githubCustomKeyEnabled": true,
  "googleDriveClientId": "googleDriveClientId",
  "googleDriveClientSecret": "googleDriveClientSecret",
  "googleDriveCustomKeyEnabled": true,
  "includeItems": "string",
  "notionClientId": "notionClientId",
  "notionClientSecret": "notionClientSecret",
  "notionCustomKeyEnabled": true,
  "onedriveClientId": "onedriveClientId",
  "onedriveClientSecret": "onedriveClientSecret",
  "onedriveCustomKeyEnabled": true,
  "profileBuckets": [
    {
      "key": "key",
      "description": "description"
    }
  ],
  "shouldLLMFilter": true,
  "workspacePrompt": "workspacePrompt"
}
Returns Examples
{
  "chunkSize": -2147483648,
  "excludeItems": "string",
  "filterPrompt": "filterPrompt",
  "githubClientId": "githubClientId",
  "githubClientSecret": "githubClientSecret",
  "githubCustomKeyEnabled": true,
  "googleDriveClientId": "googleDriveClientId",
  "googleDriveClientSecret": "googleDriveClientSecret",
  "googleDriveCustomKeyEnabled": true,
  "includeItems": "string",
  "notionClientId": "notionClientId",
  "notionClientSecret": "notionClientSecret",
  "notionCustomKeyEnabled": true,
  "onedriveClientId": "onedriveClientId",
  "onedriveClientSecret": "onedriveClientSecret",
  "onedriveCustomKeyEnabled": true,
  "profileBuckets": [
    {
      "key": "key",
      "description": "description"
    }
  ],
  "shouldLLMFilter": true,
  "workspacePrompt": "workspacePrompt"
}