Skip to content
Get started

Delete connection by ID

client.connections.deleteByID(stringconnectionID, ConnectionDeleteByIDParams { deleteDocuments } params?, RequestOptionsoptions?): ConnectionDeleteByIDResponse { id, provider }
DELETE/v3/connections/{connectionId}

Delete a specific connection by ID

ParametersExpand Collapse
connectionID: string
params: ConnectionDeleteByIDParams { deleteDocuments }
deleteDocuments?: string

Whether to also delete documents imported by this connection. Defaults to true.

ReturnsExpand Collapse
ConnectionDeleteByIDResponse { id, provider }
id: string
provider: string

Delete connection by ID

import Supermemory from 'supermemory';

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

const response = await client.connections.deleteByID('connectionId');

console.log(response.id);
{
  "id": "id",
  "provider": "provider"
}
Returns Examples
{
  "id": "id",
  "provider": "provider"
}