Toggle the kill switch

POST

api

killswitch

curl --request POST \
  --url https://api.peeve.ai/api/killswitch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "on": true
}'

{
  "ok": true,
  "kill_switch": true
}

{
  "error": "invalid_or_missing_secret_key"
}

{
  "error": "update_failed"
}

{
  "error": "unavailable"
}

Authorizations

Authorization

string

header

required

Your secret key (sk_…) as Authorization: Bearer sk_…. The header X-Peeve-Key: sk_… is accepted as an alternative.

Body

application/json

boolean

default:true

true activates the kill switch, false clears it. Defaults to true when omitted.

Response

The new state.

boolean

required

kill_switch

boolean

required

⌘I

curl --request POST \
  --url https://api.peeve.ai/api/killswitch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "on": true
}'

{
  "ok": true,
  "kill_switch": true
}

{
  "error": "invalid_or_missing_secret_key"
}

{
  "error": "update_failed"
}

{
  "error": "unavailable"
}

Overview

Users

Kill switch

Toggle the kill switch

Authorizations

Body

Response