ArchAstro. V1. Agents. AgentInstallations
(archastro v0.2.0)
Copy Markdown
AgentAgentInstallation API resource.
Summary
Functions
@spec create( ArchAstro.Client.t(), String.t(), ArchAstro.Types.Operations.PostApiV1AgentsAgentAgentInstallations.Input.t() ) :: {:ok, ArchAstro.Types.Installation.t()} | {:error, ArchAstro.Error.reason()}
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.
The newly created installation.
@spec kinds(ArchAstro.Client.t(), String.t()) :: {:ok, ArchAstro.Types.InstallationKindListResponse.t()} | {:error, ArchAstro.Error.reason()}
List available installation kinds
Returns the publicly available installation kinds supported by the API. 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.
The list of publicly available installation kinds.
@spec list(ArchAstro.Client.t(), String.t()) :: {:ok, ArchAstro.Types.InstallationListResponse.t()} | {:error, ArchAstro.Error.reason()}
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.
The list of installations for the specified agent.