Skip to content
Get started

Update settings

PATCH/v3/settings

Update settings for an organization

Body ParametersJSONExpand Collapse
body: object { workspacePrompt } or object { chunkSize, excludeItems, filterPrompt, 15 more }
One of the following:
WorkspacePrompt object { workspacePrompt }
workspacePrompt: string
maxLength1500
object { chunkSize, excludeItems, filterPrompt, 15 more }
chunkSize: optional number
minimum-2147483648
maximum2147483647
excludeItems: optional string or number or boolean or 2 more
One of the following:
string
number
boolean
map[unknown]
array of unknown
filterPrompt: optional string
githubClientId: optional string
githubClientSecret: optional string
githubCustomKeyEnabled: optional boolean
googleDriveClientId: optional string
googleDriveClientSecret: optional string
googleDriveCustomKeyEnabled: optional boolean
includeItems: optional string or number or boolean or 2 more
One of the following:
string
number
boolean
map[unknown]
array of unknown
notionClientId: optional string
notionClientSecret: optional string
notionCustomKeyEnabled: optional boolean
onedriveClientId: optional string
onedriveClientSecret: optional string
onedriveCustomKeyEnabled: optional boolean
profileBuckets: optional array of object { key, description }

Profile bucket definitions

key: string

Stable slug for the bucket, stored on each memory

minLength1
maxLength64
description: optional string

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

maxLength2000
shouldLLMFilter: optional boolean
ReturnsExpand Collapse
orgId: string
orgSlug: string
updated: object { chunkSize, excludeItems, filterPrompt, 16 more }
chunkSize: optional number
minimum-2147483648
maximum2147483647
excludeItems: optional string or number or boolean or 2 more
One of the following:
string
number
boolean
map[unknown]
array of unknown
filterPrompt: optional string
githubClientId: optional string
githubClientSecret: optional string
githubCustomKeyEnabled: optional boolean
googleDriveClientId: optional string
googleDriveClientSecret: optional string
googleDriveCustomKeyEnabled: optional boolean
includeItems: optional string or number or boolean or 2 more
One of the following:
string
number
boolean
map[unknown]
array of unknown
notionClientId: optional string
notionClientSecret: optional string
notionCustomKeyEnabled: optional boolean
onedriveClientId: optional string
onedriveClientSecret: optional string
onedriveCustomKeyEnabled: optional boolean
profileBuckets: optional array of object { key, description }

Profile bucket definitions

key: string

Stable slug for the bucket, stored on each memory

minLength1
maxLength64
description: optional string

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

maxLength2000
shouldLLMFilter: optional boolean
workspacePrompt: optional string
maxLength1500

Update settings

curl https://api.supermemory.ai/v3/settings \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
    -d '{
          "workspacePrompt": "workspacePrompt"
        }'
{
  "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"
  }
}