@archastro/sdk
    Preparing search index...

    Interface Installation

    An installation representing a connection between an agent and an external service or enablement channel. Tracks configuration, lifecycle state, and any bound integration.

    interface Installation {
        agent?: string;
        config?: Record<string, unknown>;
        created_at?: string;
        id: string;
        kind?: string;
        lookup_key?: string;
        shared_integration?: string;
        state?: string;
        status_payload?: Record<string, unknown>;
        updated_at?: string;
    }
    Index

    Properties

    agent? config? created_at? id kind? lookup_key? shared_integration? state? status_payload? updated_at?

    Properties

    agent?: string

    ID of the agent that owns this installation (agi_...). null if the installation has no agent owner.

    config?: Record<string, unknown>

    Kind-specific configuration object for this installation. Shape depends on the kind value. null if the kind requires no configuration.

    created_at?: string

    When the installation was created (ISO 8601).

    id: string

    Installation ID (cin_...).

    kind?: string

    Slug identifying the type of external service this installation connects to, e.g. "enablement/github_app" or "integration/gmail". null if not set.

    lookup_key?: string

    Caller-assigned stable identifier for this installation, used to reference it in knowledge search source_refs. null if no lookup key was provided at creation time.

    shared_integration?: string

    ID of the shared org- or app-level integration bound to this installation (int_...). null if no integration has been bound.

    state?: string

    Current lifecycle state of the installation. One of "pending", "active", "paused", or "error". "error" indicates the installation was suspended due to a policy or compliance issue and requires attention.

    status_payload?: Record<string, unknown>

    Provider-supplied status detail for this installation, set during activation or event processing. null if no status has been reported.

    updated_at?: string

    When the installation record was last updated (ISO 8601).

    Settings

    Member Visibility

    On This Page

    Properties