# Platform assistant

Source: https://docs.settlemint.com/docs/console/platform-admin/assistant
Switch the Console assistant on or off for every organisation on the platform, and see whether the platform has a free assistant key.

**Platform assistant** holds one switch that turns the Console assistant on or off for every organisation on the DALP Instance, and one line that says whether the platform has a free assistant key, the key the deployment supplies for organisations that have none of their own. The switch is on until a platform administrator turns it off, and it sits above each organisation's own assistant settings: while it is off, no organisation can use the assistant, whatever its own settings say.

What the assistant sends to a model is set per organisation, by an organisation owner or a platform administrator on the **Assistant** page in "Organisation settings". [Assistant data](https://docs.settlemint.com/docs/concepts/operating/assistant-data) describes it.

![Platform assistant page with the Assistant on this platform switch and the Free assistant key line](https://docs.settlemint.com/docs/screenshots/console-platform-admin-assistant.light.en.webp)

[Screenshot] The "Platform assistant" page with the "Assistant on this platform" switch and a line under it that says what the switch does now.

Below the switch, the **Free assistant key** row says whether a platform key is configured.

## Before you start [#before-you-start]

- You need the platform administrator role. It is set on your account, not in one organisation, and an organisation **Owner** does not have it. The platform refuses the page and its requests to every other account.
- The deployment sets the free assistant key. The **Free assistant key** row only reports whether the platform has one.

## Steps [#steps]

### Open Platform assistant [#open-platform-assistant]

Open "Platform admin", then **Platform assistant**. The page loads the current state of the switch and of the key. If the load fails, the page shows "Platform assistant switch unavailable" with "Nothing was changed. Try again." and a retry control.

### Switch the assistant on or off [#switch-the-assistant-on-or-off]

Select the **Assistant on this platform** switch. The change saves at once, with no confirmation. While it saves, the page shows "Saving…", and when it finishes, "Saved". If the save fails, the page shows "The platform switch could not be saved." and the switch keeps its earlier state. A saved change writes an [Audit trail](https://docs.settlemint.com/docs/console/reporting/audit-trail) entry with your name and the old and new state. The entry belongs to no organisation, because the change reaches every organisation, so no organisation's Audit trail lists it. A platform administrator reads it through the platform-wide query of the [audit trail](https://docs.settlemint.com/docs/concepts/records-and-evidence/audit-trail).

When the switch is on, the line under it reads "Organisations can use the assistant unless they turned it off themselves." When it is off, the line reads "The assistant is off for every organisation, including those with their own key. Questions are refused until you switch it back on."

### Read the free assistant key [#read-the-free-assistant-key]

The **Free assistant key** row reads one of two lines:

- "A platform key is configured. Organisations without their own key use it."
- "No platform key is configured. Only organisations with their own key can use the assistant. The key is set in the deployment, not on this page."

## You should see [#you-should-see]

- After you switch the assistant off, the line under the switch changes to the off message, and a member who asks the assistant a question is refused.
- After you switch it on, the line changes to the on message.
- Reload the page to confirm that the switch kept the state you chose.

## Troubleshooting [#troubleshooting]

**Platform assistant is missing from the sidebar**

The entry appears only for a platform administrator. Ask a platform administrator to change your platform role on
[Platform users](https://docs.settlemint.com/docs/console/platform-admin/users).

**The switch is on but an organisation still cannot use the assistant**

The platform switch only allows the assistant. An organisation turns it off for itself on its own "Assistant" page in
"Organisation settings", and an organisation with no key of its own needs the platform to have a free assistant key.
Read the **Free assistant key** row: when it says no platform key is configured, only organisations with their own key
can use the assistant.

**The page says the platform switch could not be saved**

The switch keeps its earlier state and nothing changed. Select the switch again.

## API routes [#api-routes]

The page reads and writes the switch through `GET /api/v2/assistant/platform` and `PATCH /api/v2/assistant/platform`. Both are limited to a platform administrator. The [Platform API reference](https://docs.settlemint.com/docs/api-reference/v2) has the request and response shapes.