Script settings

Set up

TypeScript

npm install @reminix/sdk

import { createClient } from "@reminix/sdk";

const reminix = createClient(); // reads REMINIX_API_KEY

Python

pip install reminix

from reminix import Reminix

reminix = Reminix()  # reads REMINIX_API_KEY

CLI

npm install -g @reminix/cli
reminix login

curl

export REMINIX_API_KEY="<your API key>"

Get the workspace’s script settings

GET /v1/script-settings

How the workspace governs scripts — e.g. whether publishing needs a second person.

TypeScript

await reminix.scriptSettings.get();

Python

reminix.script_settings.get()

CLI

reminix script-settings get

curl

curl -X GET "https://api.reminix.com/v1/script-settings" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Change the workspace’s script settings

PATCH /v1/script-settings

Workspace owners and admins, or a workspace API key.

TypeScript

await reminix.scriptSettings.update();

Python

reminix.script_settings.update()

CLI

reminix script-settings update

curl

curl -X PATCH "https://api.reminix.com/v1/script-settings" \
  -H "Authorization: Bearer $REMINIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Field	Description
publishNeedsSecondPersonboolean	Publishing needs a person other than the one who asks: a publish becomes a request an owner or admin approves.