@archastro/sdk
    Preparing search index...

    Class AgentAgentInstallationResource

    Index

    Constructors

    constructor

    Methods

    create kinds list

    Constructors

    Methods

    • Create an installation Creates a new installation for an agent, connecting it to an external service or enablement channel via the specified kind. The installation begins in a pending state unless an integration is supplied at creation time, in which case it is activated immediately. Supply shared_integration to bind an existing org- or app-level integration, or supply integration to create a new integration inline and activate the installation in a single request. Supplying both fields returns 422. Use lookup_key to assign a stable identifier you can reference later in knowledge search source_refs. The key must be unique within the app, org, and sandbox combination. The caller must have app scope for the app that owns the agent.

      Parameters

      • agent: string

        Agent ID (agt_...) whose installations you want to retrieve.

      • input: {
            config?: Record<string, unknown>;
            integration?: {
                access_token?: string;
                installation_id?: string;
                metadata?: Record<string, unknown>;
                refresh_token?: string;
                workspace_key?: string;
            };
            kind: string;
            lookup_key?: string;
            shared_integration?: string;
        }

        Request body.

        • Optionalconfig?: Record<string, unknown>

          Kind-specific configuration object. Shape varies by kind; omit if the kind requires no initial configuration.

        • Optionalintegration?: {
              access_token?: string;
              installation_id?: string;
              metadata?: Record<string, unknown>;
              refresh_token?: string;
              workspace_key?: string;
          }

          Inline integration fields to create for integration/* kinds. When provided, a new Integration record is created and the installation is activated immediately. Mutually exclusive with shared_integration.

        • kind: string

          Installation kind that determines the external service being connected. Examples: "enablement/github_app", "enablement/slack_bot", "integration/github", "integration/gmail", "web/site". Use the List Kinds endpoint to retrieve all supported values.

        • Optionallookup_key?: string

          Stable identifier you assign to this installation. Propagated to backing context source rows so they can be referenced via knowledge search source_refs. Must contain only lowercase letters, numbers, underscores, or hyphens (max 100 characters). Must be unique within the same app, org, and sandbox combination. Omit to skip stable referencing.

        • Optionalshared_integration?: string

          ID of an existing shared org- or app-level integration to bind to this installation. Mutually exclusive with integration.

      Returns Promise<Installation>

      The newly created installation.

    • List available installation kinds Returns the full catalogue of installation kinds supported by the platform. Use the returned kind values when calling the Create Installation endpoint. The list is platform-wide and does not vary by agent. The agent parameter is accepted for future per-agent filtering but is currently unused. The caller must have app scope to call this endpoint.

      Parameters

      • agent: string

        Agent ID (agt_...) whose installations you want to retrieve.

      Returns Promise<InstallationKindListResponse>

      The list of all supported installation kinds.

    • List installations for an agent Returns all installations belonging to the specified agent, across all kinds and states. Use this endpoint to inspect which external services and enablement channels an agent is connected to. Results are scoped to the authenticated app and are returned in an unordered array. To list installations across all agents in an app, use the top-level List Installations endpoint instead. The caller must have app scope for the app that owns the agent.

      Parameters

      • agent: string

        Agent ID (agt_...) whose installations you want to retrieve.

      Returns Promise<InstallationListResponse>

      The list of installations for the specified agent.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods