SDK: JavaScript and Python

The SDK has two jobs in code:

You want to	Use
Run a published Method from your app, answer its questions, and get its result	`Method` (Node) or `Method` (Python). See Production runs.
Load a Method file, or run it directly with the runtime	`loadMethod` and `runMethod` (Node), `load_method` and `run_method` (Python).

Run a published Method from an app

cd path/to/method-folder
method connect path/to/app

method connect writes METHOD_API_KEY to the app’s .env and prints the install line and the code for Node or Python. Then:

import { Method } from "@method-ai-hq/sdk";

const method = new Method(); // METHOD_API_KEY from the environment or .env
const run = await method.run({ method: "wf_…", inputs: { ticket_id: "T-1042" } });
console.log(run.status, run.result);

The first method.run starts a worker in the app’s process. See Production runs for questions, webhooks, and separate workers.

Run a Method file from code

npm install https://app.withmethod.ai/downloads/method-ai-hq-sdk-latest.tgz

import { readFileSync } from 'node:fs';
import { loadMethod, runMethod } from '@method-ai-hq/sdk';

const method = loadMethod(readFileSync('checked-file.method', 'utf8'));
const result = await runMethod('checked-file.method', { allow_local_processes: true }, {
  inputs: { text: 'Hello\n' },
  runDir: 'runs/example',
});
console.log(method.name, result.status);

loadMethod parses and validates a YAML or JSON string. runMethod(file, config, options) is the bare runtime. It runs scripts and local agents. It does not sign in, save versions, or send runs to the dashboard, and it has no hosted models: use method run for that. Options include inputs, state, runDir, resume, retry, human, signal, and onEvent.

Python

Python 3.9 or later, with Node.js 22 or later and the JavaScript SDK:

npm install -g https://app.withmethod.ai/downloads/method-ai-hq-sdk-latest.tgz
pip install https://app.withmethod.ai/downloads/method_ai-0.24.0-py3-none-any.whl

from withmethod import Method

method = Method()  # METHOD_API_KEY from the environment or .env
run = method.run("wf_…", {"ticket_id": "T-1042"})
print(run["status"], run.get("result"))

load_method and run_method work as in Node. Python calls the same Node runtime; it is not a separate executor. withmethod on the command line forwards to method.

Versions

method --version shows the SDK, runtime, and format. The download manifest lists package names and SHA-256 hashes. The latest URL can change; use an exact version URL for a fixed release. See Source and downloads.

​Run a published Method from an app

​Run a Method file from code

​Python

​Versions

Run a published Method from an app

Run a Method file from code

Python

Versions