Skip to content
ReminixReminixReminix Docs

Runs

Set up

Section titled “Set up”
Terminal window
npm install @reminix/sdk
import { createClient } from "@reminix/sdk";


const reminix = createClient(); // reads REMINIX_API_KEY

Run a script

Section titled “Run a script”

POST /v1/scripts/{slug}/runs

Runs the script’s PUBLISHED version with these inputs and answers when it finishes, with its output (or error).

await reminix.runs.create("unlock-account");
FieldDescription
slugstring, path, required
inputsobjectThe script's inputs, by name. Default: none.
viastringHow it was started (for the history). Default: api; agents' runs are recorded as mcp.
More about this endpoint

The inputs are checked against the version’s input schema first — a mismatch is a 400 with one details entry per field. A file input takes a file id (upload it with files.create first, or pass another run’s output) or an https link Reminix fetches. The script runs in its own container, reaching only the hosts its version declares, for at most 30 seconds — a script whose timeout is longer runs durably and answers 202 at once. Every run counts toward the workspace’s runs usage.

List runs

Section titled “List runs”

GET /v1/runs

The workspace’s runs, newest first — of one script with ?script=<slug>.

await reminix.runs.list();
FieldDescription
limitnumber, queryItems per page, 1–100 (default 25).
cursorstring, queryOpaque token from a previous page's nextCursor.
scriptstring, queryOnly this script's runs (its slug).
More about this endpoint

Paginate with the opaque nextCursor token.

Get a run

Section titled “Get a run”

GET /v1/runs/{runId}

One run: its inputs, status, output or error, who started it and how, and its files — given to it and written by it — with download links.

await reminix.runs.get("<run-id>");
FieldDescription
runIdstring, path, required

Cancel a run

Section titled “Cancel a run”

POST /v1/runs/{runId}/cancel

Stops a LONG run that is still running: its code stops and the run ends cancelled.

await reminix.runs.cancel("<run-id>");
FieldDescription
runIdstring, path, required
More about this endpoint

For the person who started it, the script’s owner, or an owner or admin.

Get a run’s log

Section titled “Get a run’s log”

GET /v1/runs/{runId}/logs

What the script wrote to standard error, line by line, with a line per request it made.

await reminix.runs.logs("<run-id>");
FieldDescription
runIdstring, path, required