@archastro/sdk
    Preparing search index...

    Interface InstallationKind

    A supported installation kind describing a category of external service or enablement channel an agent can be connected to.

    interface InstallationKind {
        accepts_sources?: boolean;
        category?: string;
        config_schema?: Record<string, unknown>;
        description?: string;
        kind: string;
        label?: string;
        provider?: string;
        requires_integration?: boolean;
    }
    Index

    Properties

    accepts_sources? category? config_schema? description? kind label? provider? requires_integration?

    Properties

    accepts_sources?: boolean

    When true, sources can be attached to installations of this kind to supply additional context to the agent.

    category?: string

    Grouping category for UI display purposes, e.g. "enablement" or "integration". null if uncategorized.

    config_schema?: Record<string, unknown>

    JSON Schema object describing the shape of the config parameter accepted when creating or updating an installation of this kind. null if the kind accepts no configuration.

    description?: string

    Short prose description of what this kind connects to and how it is used. null if no description is defined.

    kind: string

    Unique slug identifying this installation kind, e.g. "enablement/github_app", "integration/gmail", or "web/site". Pass this value as kind when creating an installation.

    label?: string

    Human-readable display name for this kind, e.g. "GitHub App". null if the kind has no label defined.

    provider?: string

    Identifier of the external provider this kind connects to, e.g. "github" or "slack". null for kinds with no specific provider.

    requires_integration?: boolean

    When true, this kind requires an integration to be provided (either inline or via shared_integration) before the installation can be activated.

    Settings

    Member Visibility

    On This Page

    Properties