Skip to content
Get started

Connections

External service integrations

Create connection
client.connections.create("notion" | "google-drive" | "onedrive" | 4 moreprovider, ConnectionCreateParams { containerTag, containerTags, documentLimit, 2 more } body, RequestOptionsoptions?): ConnectionCreateResponse { id, authLink, expiresIn, redirectsTo }
POST/v3/connections/{provider}
Get connection (by id)
client.connections.getByID(stringconnectionID, RequestOptionsoptions?): ConnectionGetByIDResponse { id, createdAt, provider, 5 more }
GET/v3/connections/{connectionId}
Get connection (by provider)
client.connections.getByTag("notion" | "google-drive" | "onedrive" | 4 moreprovider, ConnectionGetByTagParams { containerTags } body, RequestOptionsoptions?): ConnectionGetByTagResponse { id, createdAt, provider, 5 more }
POST/v3/connections/{provider}/connection
Delete connection by ID
client.connections.deleteByID(stringconnectionID, ConnectionDeleteByIDParams { deleteDocuments } params?, RequestOptionsoptions?): ConnectionDeleteByIDResponse { id, provider }
DELETE/v3/connections/{connectionId}
Delete connection
client.connections.deleteByProvider("notion" | "google-drive" | "onedrive" | 4 moreprovider, ConnectionDeleteByProviderParams { containerTags } body, RequestOptionsoptions?): ConnectionDeleteByProviderResponse { id, provider }
DELETE/v3/connections/{provider}
Sync connection
client.connections.import("notion" | "google-drive" | "onedrive" | 4 moreprovider, ConnectionImportParams { containerTags } body, RequestOptionsoptions?): ConnectionImportResponse
POST/v3/connections/{provider}/import
List connections
client.connections.list(ConnectionListParams { containerTags } body, RequestOptionsoptions?): ConnectionListResponse { id, createdAt, provider, 5 more }
POST/v3/connections/list
List documents
client.connections.listDocuments("notion" | "google-drive" | "onedrive" | 4 moreprovider, ConnectionListDocumentsParams { containerTags } body, RequestOptionsoptions?): ConnectionListDocumentsResponse { id, createdAt, status, 4 more }
POST/v3/connections/{provider}/documents
Configure connection
client.connections.configure(stringconnectionID, ConnectionConfigureParams { resources } body, RequestOptionsoptions?): ConnectionConfigureResponse { message, success, webhooksRegistered }
POST/v3/connections/{connectionId}/configure
Fetch resources
client.connections.resources(stringconnectionID, ConnectionResourcesParams { page, parent_id, per_page } query?, RequestOptionsoptions?): ConnectionResourcesResponse { resources, total_count }
GET/v3/connections/{connectionId}/resources
ModelsExpand Collapse
ConnectionCreateResponse { id, authLink, expiresIn, redirectsTo }
id: string
expiresIn: string
redirectsTo?: string
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>
ConnectionGetByTagResponse { 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>
ConnectionDeleteByIDResponse { id, provider }
id: string
provider: string
ConnectionDeleteByProviderResponse { id, provider }
id: string
provider: string
ConnectionImportResponse = string
ConnectionListResponse = Array<ConnectionListResponseItem>
id: string
createdAt: string
formatdatetime
provider: string
DeprecatedcontainerTags?: Array<string>
documentLimit?: number
email?: string
expiresAt?: string
formatdatetime
metadata?: Record<string, unknown>
ConnectionListDocumentsResponse = Array<ConnectionListDocumentsResponseItem>
id: string
createdAt: string
formatdatetime
status: string
formatdatetime
summary: string | null
title: string | null
type: string
updatedAt: string
formatdatetime
ConnectionConfigureResponse { message, success, webhooksRegistered }
message: string
success: boolean
webhooksRegistered?: number
ConnectionResourcesResponse { resources, total_count }
resources: Array<Record<string, unknown>>
total_count?: number