Scripts

Set up

npm install @reminix/sdk

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

const reminix = createClient(); // reads REMINIX_API_KEY

pip install reminix

from reminix import Reminix

reminix = Reminix()  # reads REMINIX_API_KEY

npm install -g @reminix/cli
reminix login

export REMINIX_API_KEY="<your API key>"

List scripts

GET /v1/scripts

The workspace’s scripts you may see, newest first, with the version each runs, tags and 30-day stats.

await reminix.scripts.list();

reminix.scripts.list()

reminix scripts list

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

Field	Description
`limit`number, query	Items per page, 1–100 (default 25).
`cursor`string, query	Opaque token from a previous page's nextCursor.
`q`string, query	Search the name, slug, description and tags — each word matches the start of a word. Results are best match first, one page (no cursor).
`tag`string, query	Only scripts with this tag.
`owner`string, query	An owner's user id.
`published`string, query	`true`: only scripts with a published version.
`archived`string, query	`true`: the archived scripts instead (they are left out otherwise).

More about this endpoint

Search with q (best match first) and filter by tag, owner or published — look here before writing a new one. Paginate with the opaque nextCursor token.

Create a script

POST /v1/scripts

Creates an empty script — upload a version, then publish it.

await reminix.scripts.create({
  slug: "unlock-account",
  name: "Unlock an account",
});

reminix.scripts.create(slug="unlock-account", name="Unlock an account")

reminix scripts create --slug unlock-account --name 'Unlock an account'

curl -X POST "https://api.reminix.com/v1/scripts" \
  -H "Authorization: Bearer $REMINIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"unlock-account","name":"Unlock an account"}'

Field	Description
`slug`string, required	Its id in URLs and commands: lowercase letters, digits and dashes, unique in the workspace.
`name`string, required	What people see in the app.
`description`string	What it does, in a sentence or two.

More about this endpoint

The slug names it everywhere (the API path, the agent tool, the command line) and is unique in the workspace.

Get a script

GET /v1/scripts/{slug}

One script by its slug: its name, owner, status, published version, README, and who uses it — people, schedules, triggers and the scripts that follow it.

await reminix.scripts.get("unlock-account");

reminix.scripts.get("unlock-account")

reminix scripts get unlock-account

curl -X GET "https://api.reminix.com/v1/scripts/unlock-account" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
`slug`string, path, required

Change a script

PATCH /v1/scripts/{slug}

Changes its name or description, who may see and run it (access, teams), and which runs need a person’s approval.

await reminix.scripts.update("unlock-account");

reminix.scripts.update("unlock-account")

reminix scripts update unlock-account

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

Field	Description
`slug`string, path, required
`name`string	What people see in the app.
`description`string	What it does, in a sentence or two.
`access`string	`workspace`: every member may see and run it. `teams`: only members of `teamIds` (and owners and admins).
`teamIds`array	With `access: teams`: the teams whose members may see and run it.
`tags`array	Up to 10; lowercase letters, digits and dashes.
`approvalPolicy`string	Which runs wait for a person's approval: `none`, `agents` (runs started through an agent's token) or `always`.

More about this endpoint

The script’s owner, or a workspace owner or admin.

Archive a script

POST /v1/scripts/{slug}/archive

Stops it: it leaves the scripts list, can’t be run, and its schedules and triggers skip it.

await reminix.scripts.archive("unlock-account");

reminix.scripts.archive("unlock-account")

reminix scripts archive unlock-account

curl -X POST "https://api.reminix.com/v1/scripts/unlock-account/archive" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
`slug`string, path, required

More about this endpoint

Its runs, versions and files stay on record — scripts are archived, never deleted. Refused while a run of it is going or waiting for approval. The script’s owner, or a workspace owner or admin.

Restore an archived script

POST /v1/scripts/{slug}/restore

Brings an archived script back: listed and runnable again, its schedules and triggers resumed.

await reminix.scripts.restore("unlock-account");

reminix.scripts.restore("unlock-account")

reminix scripts restore unlock-account

curl -X POST "https://api.reminix.com/v1/scripts/unlock-account/restore" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
`slug`string, path, required

More about this endpoint

The script’s owner, or a workspace owner or admin.