Integration setup

AKOS keeps provider-specific setup instructions in the integration setup registry. The assistant, Connections screen, and CLI read that registry instead of duplicating setup steps in static docs.

Use Home (Assistant) when you want guided setup in conversation. It can explain what happens inside AKOS, what you must complete in the external service, which permissions are requested, and which health check confirms the connection.

Use the CLI when you need the same setup data for automation or review:

agentskit-os connections guide slack
agentskit-os connections guide discord --json
agentskit-os connections guide --category llm --implemented-only

Each guide can include:

• The preferred setup mode: OAuth, app or bot installation, guided secret, platform-managed setup, or fallback.
• The setup CTA and summary shown in product surfaces.
• Required scopes or permissions.
• External credential links when a provider needs an API key.
• The health-check method AKOS should run after setup.
• Assistant instructions for safe wording and redaction.

For tenant setup, prefer OAuth or app installation when available. Ask for API keys only when the registry says a guided secret is the right path. Never paste raw secrets into chat output; store them through Connections or the vault-backed CLI flow.

implementationStatus: real means AKOS has a provider-specific runtime path. It does not mean your tenant already has a saved credential or a passing health check. The assistant must keep those states separate and state exactly what is missing before it calls a connection ready.

For the common marketing workflow:

1. Google Drive: choose the Google account and brief folder/file, grant the minimum Drive scope, then run the Drive health check.
2. Gmail: choose the Google account and reviewer address, grant the minimum send scope (plus read only if the workflow reads replies), then run the Gmail health check.
3. Buffer: authorize the correct Buffer account, choose each social channel, then run the Buffer health check.
4. Return to Home and review the workflow preview. Approve saving the current revision and run a dry run. The Buffer step remains a draft/schedule proposal; any supported final publication must stay behind human approval.

If a check fails, Home shows the failed provider, the safe evidence available, and the next setup or retry step. It never treats a pasted credential as proof and never repeats the secret in its response.

The Connections screen is still the main place to connect, verify, rotate, and remove provider credentials.

For OAuth-protected Knowledge sources, complete the provider connection here first, then add the source in the Knowledge screen.

For scoped keys that let external apps call /v1/automations/*, use Connections › External apps and read Public automation API.

Provider setup checklist

Use the registry guide first, then prepare the provider-side object that matches its setup mode:

When the setup is ambiguous, the assistant should ask which tenant/workspace, environment, provider account, and permission level to use before it renders a connect action.

Live validation

Use the provider health check in Connections after setup. Health checks record only provider, status, and safe proof metadata; tokens, client secrets, API keys, and private keys are redacted from reports and logs.

Related screens