Skip to content
Get started

Connections

External service integrations

Create connection
POST/v3/connections/{provider}
Get connection (by id)
GET/v3/connections/{connectionId}
Get connection (by provider)
POST/v3/connections/{provider}/connection
Delete connection by ID
DELETE/v3/connections/{connectionId}
Delete connection
DELETE/v3/connections/{provider}
Sync connection
POST/v3/connections/{provider}/import
List connections
POST/v3/connections/list
List documents
POST/v3/connections/{provider}/documents
Configure connection
POST/v3/connections/{connectionId}/configure
Fetch resources
GET/v3/connections/{connectionId}/resources
ModelsExpand Collapse
ConnectionCreateResponse object { id, authLink, expiresIn, redirectsTo }
id: string
expiresIn: string
redirectsTo: optional string
ConnectionGetByIDResponse object { id, createdAt, provider, 5 more }
id: string
createdAt: string
formatdatetime
provider: string
DeprecatedcontainerTags: optional array of string
documentLimit: optional number
email: optional string
expiresAt: optional string
formatdatetime
metadata: optional map[unknown]
ConnectionGetByTagResponse object { id, createdAt, provider, 5 more }
id: string
createdAt: string
formatdatetime
provider: string
DeprecatedcontainerTags: optional array of string
documentLimit: optional number
email: optional string
expiresAt: optional string
formatdatetime
metadata: optional map[unknown]
ConnectionDeleteByIDResponse object { id, provider }
id: string
provider: string
ConnectionDeleteByProviderResponse object { id, provider }
id: string
provider: string
ConnectionImportResponse = string
ConnectionListResponse = array of object { id, createdAt, provider, 5 more }
id: string
createdAt: string
formatdatetime
provider: string
DeprecatedcontainerTags: optional array of string
documentLimit: optional number
email: optional string
expiresAt: optional string
formatdatetime
metadata: optional map[unknown]
ConnectionListDocumentsResponse = array of object { id, createdAt, status, 4 more }
id: string
createdAt: string
formatdatetime
status: string
formatdatetime
summary: string
title: string
type: string
updatedAt: string
formatdatetime
ConnectionConfigureResponse object { message, success, webhooksRegistered }
message: string
success: boolean
webhooksRegistered: optional number
ConnectionResourcesResponse object { resources, total_count }
resources: array of map[unknown]
total_count: optional number