Skip to content
Get started

Get connection (by id)

client.connections.getByID(stringconnectionID, RequestOptionsoptions?): ConnectionGetByIDResponse { id, createdAt, provider, 5 more }
GET/v3/connections/{connectionId}

Get connection details with id

ParametersExpand Collapse
connectionID: string
ReturnsExpand Collapse
ConnectionGetByIDResponse { id, createdAt, provider, 5 more }
id: string
createdAt: string
formatdatetime
provider: string
DeprecatedcontainerTags?: Array<string>
documentLimit?: number
email?: string
expiresAt?: string
formatdatetime
metadata?: Record<string, unknown>

Get 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.getByID('connectionId');

console.log(response.id);
{
  "id": "id",
  "createdAt": "createdAt",
  "provider": "provider",
  "containerTags": [
    "string"
  ],
  "documentLimit": 0,
  "email": "email",
  "expiresAt": "expiresAt",
  "metadata": {
    "foo": "bar"
  }
}
Returns Examples
{
  "id": "id",
  "createdAt": "createdAt",
  "provider": "provider",
  "containerTags": [
    "string"
  ],
  "documentLimit": 0,
  "email": "email",
  "expiresAt": "expiresAt",
  "metadata": {
    "foo": "bar"
  }
}