Skip to content
Get started

Connections

External service integrations

Create connection
connections.create(Literal["notion", "google-drive", "onedrive", 4 more]provider, ConnectionCreateParams**kwargs) -> ConnectionCreateResponse
POST/v3/connections/{provider}
Get connection (by id)
connections.get_by_id(strconnection_id) -> ConnectionGetByIDResponse
GET/v3/connections/{connectionId}
Get connection (by provider)
connections.get_by_tag(Literal["notion", "google-drive", "onedrive", 4 more]provider, ConnectionGetByTagParams**kwargs) -> ConnectionGetByTagResponse
POST/v3/connections/{provider}/connection
Delete connection by ID
connections.delete_by_id(strconnection_id, ConnectionDeleteByIDParams**kwargs) -> ConnectionDeleteByIDResponse
DELETE/v3/connections/{connectionId}
Delete connection
connections.delete_by_provider(Literal["notion", "google-drive", "onedrive", 4 more]provider, ConnectionDeleteByProviderParams**kwargs) -> ConnectionDeleteByProviderResponse
DELETE/v3/connections/{provider}
Sync connection
connections.import_(Literal["notion", "google-drive", "onedrive", 4 more]provider, ConnectionImportParams**kwargs) -> ConnectionImportResponse
POST/v3/connections/{provider}/import
List connections
connections.list(ConnectionListParams**kwargs) -> ConnectionListResponse
POST/v3/connections/list
List documents
connections.list_documents(Literal["notion", "google-drive", "onedrive", 4 more]provider, ConnectionListDocumentsParams**kwargs) -> ConnectionListDocumentsResponse
POST/v3/connections/{provider}/documents
Configure connection
connections.configure(strconnection_id, ConnectionConfigureParams**kwargs) -> ConnectionConfigureResponse
POST/v3/connections/{connectionId}/configure
Fetch resources
connections.resources(strconnection_id, ConnectionResourcesParams**kwargs) -> ConnectionResourcesResponse
GET/v3/connections/{connectionId}/resources
ModelsExpand Collapse
class ConnectionCreateResponse:
id: str
expires_in: str
redirects_to: Optional[str]
class ConnectionGetByIDResponse:
id: str
created_at: str
formatdatetime
provider: str
Deprecatedcontainer_tags: Optional[List[str]]
document_limit: Optional[float]
email: Optional[str]
expires_at: Optional[str]
formatdatetime
metadata: Optional[Dict[str, object]]
class ConnectionGetByTagResponse:
id: str
created_at: str
formatdatetime
provider: str
Deprecatedcontainer_tags: Optional[List[str]]
document_limit: Optional[float]
email: Optional[str]
expires_at: Optional[str]
formatdatetime
metadata: Optional[Dict[str, object]]
class ConnectionDeleteByIDResponse:
id: str
provider: str
class ConnectionDeleteByProviderResponse:
id: str
provider: str
str
List[ConnectionListResponseItem]
id: str
created_at: str
formatdatetime
provider: str
Deprecatedcontainer_tags: Optional[List[str]]
document_limit: Optional[float]
email: Optional[str]
expires_at: Optional[str]
formatdatetime
metadata: Optional[Dict[str, object]]
List[ConnectionListDocumentsResponseItem]
id: str
created_at: str
formatdatetime
status: str
formatdatetime
summary: Optional[str]
title: Optional[str]
type: str
updated_at: str
formatdatetime
class ConnectionConfigureResponse:
message: str
success: bool
webhooks_registered: Optional[float]
class ConnectionResourcesResponse:
resources: List[Dict[str, object]]
total_count: Optional[float]