Collection Assistant

Set Agent Switch

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.

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

Request body

onboolean required
permission'granted' | 'denied' | 'undetermined' | 'provisional' nullable
push_tokenstring nullable
source'settings' | 'first_save' | 'shortcut' | 'ask'

Response

Successful Response

choice'on' | 'off' | 'unset' required
activeboolean required
readyboolean required
pausedboolean required
reason'no_permission' | 'no_token' | 'push_off' nullable
askedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.