Update settings

client.settings.update(, ?): SettingUpdateResponse { orgId, orgSlug, updated }

PATCH/v3/settings

Update settings for an organization

ParametersExpand Collapse

SettingUpdateParams = Variant0 | Variant1

SettingUpdateParamsBase { workspacePrompt }

workspacePrompt: string | null

maxLength1500

Variant0 extends SettingUpdateParamsBase { workspacePrompt }

Variant1 extends SettingUpdateParamsBase { workspacePrompt }

ReturnsExpand Collapse

SettingUpdateResponse { orgId, orgSlug, updated }

orgId: string

orgSlug: string

updated: Updated { 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

Update 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.update({ workspacePrompt: 'workspacePrompt' });

console.log(setting.orgId);

{
  "orgId": "orgId",
  "orgSlug": "orgSlug",
  "updated": {
    "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

{
  "orgId": "orgId",
  "orgSlug": "orgSlug",
  "updated": {
    "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"
  }
}