Docs / Guides

Integrations

Call MiniCut from another tool, a script or an agent. Run one command, read the exit code, then read one JSON object. No MiniCut project and no sign-in needed.

Run a command

This runs the free take check on a video file. It runs on this computer, needs no sign-in and makes no project.

out=$(minicut check take take.mp4 --json)
code=$?
echo "exit code: $code"
echo "$out"

Replace take.mp4 with the path to your clip. On Windows, Node needs shell: true to find minicut.

Output

The JSON object it prints, as the tests recorded it:

Output, exit 0
{
  "ok": true,
  "type": "mh.verdict",
  "check": "take",
  "at": "<volatile>",
  "clip": null,
  "take": "<dir>/take.mp4",
  "kind": "file",
  "seconds": 2,
  "window": [
    0,
    2
  ],
  "result": "pass",
  "failures": [],
  "notes": [
    "no --lines file: the spoken words were not checked (add --lines <text file> to check them, free, local speech engine)",
    "the look is not checked here: minicut check zoom <dir>/take.mp4 --json writes full-size pictures to look at"
  ],
  "sheet": null,
  "readback": null,
  "takes_made": null,
  "cap": null
}

A command that cannot finish prints one error object with a code and a message instead, and exits with the code for that error.

Exit codes

Every command exits with one of these codes.

Exit codeNameMeaning
0OKok
1CHECK_FAILEDcheck failed
2COULD_NOT_RUNcould not run
3NEEDS_YESneeds yes
4LIMIT_REFUSED_RESERVEDlimit refused reserved
5FIX_INPUTfix input
6NOT_READYnot ready
7OFFLINEoffline
8TRY_AGAINtry again
9UPGRADE_OR_CREDITSupgrade or credits
10SIGN_INsign in
11FLAGflag
12TOO_OLDtoo old

Next

Updated 2026-11-12.