# AI assistant

> Source: https://docs.clonepartner.com/ui/ai-assistant/

Envoy includes an app-wide assistant powered by Anthropic. It can answer product questions, search Envoy, inspect resources through tools, help author task YAML, and perform supported API actions.

## Open the assistant

Use the assistant button or:

- `Cmd/Ctrl+Shift+A` to toggle the panel;
- `Cmd/Ctrl+K` to open app search.

The assistant panel is available across authenticated routes. Conversations are saved and can be searched or reopened.

## Give useful context

Attach a task, connector, job, run, dashboard, or other supported record with the composer. The assistant receives validated identifiers and can load current data through authorized tools.

When working in the task editor, the assistant can use the live YAML as context and return revised YAML. Describe:

- the source and destination;
- representative record shapes;
- idempotency requirements;
- error behavior;
- expected output.

Do not paste passwords, tokens, raw connector configurations, or unnecessary personal data into a prompt.

## Product actions

The assistant can discover available REST operations, search app records, navigate to relevant pages, and call permitted APIs as the signed-in user.

Destructive operations pause for inline approval. Review the exact method, path, and summary before approving. An approval is scoped to the pending action and expires; it is not a blanket authorization for future operations.

Authentication, API-key management, executor administration, and selected other sensitive paths are unavailable to the assistant.

## Connector discovery

Connector tools help the assistant understand schemas and produce connector-aware YAML. Connector list data exposed to the assistant is redacted.

For investigation:

1. attach or name the connector;
2. ask for a narrow read;
3. confirm the resource and query;
4. request a reusable task or preset only after validating results.

The assistant should not create a team-visible Data Explorer preset unless you ask it to save or share the query.

## Knowledge references

The assistant uses the Envoy technical reference corpus shipped with the runtime. Administrators can manage deployment-specific AI reference overrides.

An enabled override with the same filename takes precedence over the packaged reference. If guidance appears stale after an upgrade, review **AI References** for an older enabled override.

See [Manage AI references](/ui/ai-references) for the override workflow.

## Configure the provider

The assistant requires an Anthropic API key. An admin or superadmin can store or clear it from **Settings** when server-side editing is enabled. It can also be supplied in `envoy-server.yaml`.

Availability depends on outbound access to the selected provider. Local search embeddings can be packaged with a build, while provider calls still leave the deployment.

## Security and review

- Provider prompts can contain user text and data returned by approved tools.
- Product role checks still apply to tool calls.
- Sensitive action summaries are audited with known secret fields redacted.
- Redaction is defense in depth, not permission to paste secrets.
- Validate generated YAML and use a bounded test run before production.
- Reject an approval when the proposed target or payload is unexpected.