---
title: "Set Agent Switch"
method: PUT
path: "/api/v1/assistant/agent/switch"
tags: ["Collection Assistant"]
---

# Set Agent Switch

`PUT /api/v1/assistant/agent/switch`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/assistant/agent/switch`
- Auth: HTTP bearer

Turn the Collection Agent on or off. On needs granted notification
permission and a push token; without them it answers 409 push_required
with the reason, and nothing is stored.

## Request body

- AgentSwitchIn
  - `on` boolean, required
  - `permission` 'granted' | 'denied' | 'undetermined' | 'provisional', nullable
  - `push_token` string, nullable
  - `source` 'settings' | 'first_save' | 'shortcut' | 'ask'

## Response `200`

Successful Response

- AgentSwitchOut
  - `choice` 'on' | 'off' | 'unset', required
  - `active` boolean, required
  - `ready` boolean, required
  - `paused` boolean, required
  - `reason` 'no_permission' | 'no_token' | 'push_off', nullable
  - `asked` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api.md) · [All operations](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/revisions/fcb441f55161?raw)