Connectors

v0.1.0

Manage your installed integrations — configuration, credentials, and usage monitoring

Python

bash
pip install human-sdk

List Installations

List installed connectors with pagination Returns all connector installations visible to the authenticated passport, optionally filtered by status or connector type.

ParameterDescription
filtersOptional filters and pagination
python
// First page
const page1 = await client.connectors.listInstallations({ limit: 20 });
// Next page
const page2 = await client.connectors.listInstallations({
limit: 20,
cursor: page1.next_cursor
});
// With filters
const active = await client.connectors.listInstallations({
status: 'active',
connector_id: 'conn_slack'
});

Returns: Paginated list of connector installations

Errors

AuthorizationError — If not authorized to list installations

Update Installation

Update an installation's configuration or status Use this to change connector-specific settings or to disable/re-enable an installation.

ParameterDescription
idInstallation ID
requestFields to update
python
const updated = await client.connectors.updateInstallation('inst_123', {
config: { webhook_url: 'https://example.com/hook' },
status: 'active'
});

Returns: Updated connector installation

Errors

NotFoundError — If installation doesn't exist

AuthorizationError — If not authorized to update installation

ValidationError — If request is invalid

Get Usage

Get usage statistics for an installation Returns call volume, success/failure counts, and latency metrics for the current billing period.

ParameterDescription
idInstallation ID
python
const usage = await client.connectors.getUsage('inst_123');
console.log(`Total calls: ${usage.total_calls}`);
console.log(`Success rate: ${(usage.successful_calls / usage.total_calls * 100).toFixed(1)}%`);
console.log(`Avg latency: ${usage.avg_latency_ms}ms`);

Returns: Usage statistics for the installation

Errors

NotFoundError — If installation doesn't exist

AuthorizationError — If not authorized to view usage

Types

python
interface ConnectorInstallation {
/** Unique installation ID */
id: string;
/** ID of the connector definition being installed */
connector_id: string;
/** Passport that owns this installation */
passport_id: string;
/** Current installation status */
status: InstallationStatus;
/** Installation-specific configuration (connector-dependent schema) */
config: Record<string, unknown>;
/** Reference to the stored credential for this installation */
credentials_id: string;
}
interface InstallationUsage {
/** Installation these stats belong to */
installation_id: string;
/** Time period for the usage rollup (e.g. "2026-02") */
period: string;
/** Total API calls made through this installation */
total_calls: number;
/** Calls that completed successfully */
successful_calls: number;
/** Calls that resulted in an error */
failed_calls: number;
/** Average round-trip latency in milliseconds */
avg_latency_ms: number;
}
interface UpdateInstallationRequest {
/** Updated configuration (merged with existing config) */
config?: Record<string, unknown>;
/** Updated status */
status?: InstallationStatus;
}
interface InstallationListFilters {
/** Filter by installation status */
status?: InstallationStatus;
/** Filter by connector definition ID */
connector_id?: string;
}