Run a workflow (REST + SDK)

# Reused by every request below. The base URL has no /v1 path segment.
export MODULEX_API_KEY="mx_live_xxx"
export MODULEX_ORG_ID="11111111-1111-1111-1111-111111111111"
export MODULEX_BASE_URL="https://api.modulex.dev"

# Sanity check: confirm the key + org resolve.
curl "$MODULEX_BASE_URL/auth/me" \
  -H "Authorization: Bearer $MODULEX_API_KEY" \
  -H "X-Organization-ID: $MODULEX_ORG_ID"

import asyncio
from modulex import Modulex

client = Modulex(
    api_key="mx_live_xxx",
    organization_id="11111111-1111-1111-1111-111111111111",
    # base_url defaults to https://api.modulex.dev
)

async def main():
    me = await client.auth.me()
    print(me["user_id"])

asyncio.run(main())

import { Modulex } from 'modulex-js';

const client = new Modulex({
  apiKey: 'mx_live_xxx',
  organizationId: '11111111-1111-1111-1111-111111111111',
  // baseUrl defaults to https://api.modulex.dev
});

const me = await client.auth.me();
console.log(me.user_id);

# Run a saved, deployed workflow.
curl -X POST "$MODULEX_BASE_URL/workflows/run" \
  -H "Authorization: Bearer $MODULEX_API_KEY" \
  -H "X-Organization-ID: $MODULEX_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
        "workflow_id": "550e8400-e29b-41d4-a716-446655440000",
        "input": { "query": "AI trends" },
        "config": { "recursion_limit": 50 }
      }'

run = await client.executions.run(
    workflow_id="550e8400-e29b-41d4-a716-446655440000",
    input={"query": "AI trends"},
    config={"recursion_limit": 50},
)
print(run.status, run.run_id)  # "running" 6a7b8c9d-...

const run = await client.executions.run({
  workflowId: '550e8400-e29b-41d4-a716-446655440000',
  input: { query: 'AI trends' },
  config: { recursion_limit: 50 },
});
console.log(run.status, run.run_id); // "running" 6a7b8c9d-...

# -N disables buffering so frames arrive as they are emitted.
curl -N "$MODULEX_BASE_URL/workflows/listen/6a7b8c9d-1e2f-3g4h-5i6j-7k8l9m0n1o2p" \
  -H "Authorization: Bearer $MODULEX_API_KEY" \
  -H "X-Organization-ID: $MODULEX_ORG_ID"

# executions.listen() yields the parsed data object of each frame.
async for event in client.executions.listen(run.run_id):
    etype = event.get("type")
    if etype == "node_update":
        print("node:", event.get("node"))
    elif etype == "done":
        print("done:", event["data"]["message"])
        break
    elif etype == "error":
        print("error:", event.get("message"))
        break

// listen() is an async generator yielding each frame's parsed data.
for await (const event of client.executions.listen(run.run_id)) {
  if (event.type === 'node_update') {
    console.log('node:', event.node);
  } else if (event.type === 'done') {
    console.log('done:', event.data.message);
    break;
  } else if (event.type === 'error') {
    console.log('error:', event.message);
    break;
  }
}

# A 429 includes a Retry-After header; back off and retry.
curl -i -X POST "$MODULEX_BASE_URL/workflows/run" \
  -H "Authorization: Bearer $MODULEX_API_KEY" \
  -H "X-Organization-ID: $MODULEX_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"workflow_id":"550e8400-e29b-41d4-a716-446655440000","input":{"query":"AI trends"}}'
# HTTP/1.1 402 Payment Required
# {"code":"credit_plan_exhausted","layer":"credit",...}

from modulex import (
    PaymentRequiredError,
    QuotaExceededError,
    RateLimitError,
)

try:
    run = await client.executions.run(
        workflow_id="550e8400-e29b-41d4-a716-446655440000",
        input={"query": "AI trends"},
    )
except RateLimitError as exc:        # 429
    print("rate limited; back off", exc)
except QuotaExceededError as exc:    # 403
    print("quota exceeded", exc)
except PaymentRequiredError as exc:  # 402 (credit/wallet)
    print("out of credits", exc)

import { ModulexError, RateLimitError } from 'modulex-js';

try {
  const run = await client.executions.run({
    workflowId: '550e8400-e29b-41d4-a716-446655440000',
    input: { query: 'AI trends' },
  });
} catch (err) {
  if (err instanceof RateLimitError) {
    console.log('rate limited; back off', err); // 429
  } else if (err instanceof ModulexError && err.status === 402) {
    console.log('out of credits', err); // 402 — no dedicated payment class
  } else {
    throw err;
  }
}

curl "$MODULEX_BASE_URL/workflow-runs?workflow_id=550e8400-e29b-41d4-a716-446655440000&limit=20" \
  -H "Authorization: Bearer $MODULEX_API_KEY" \
  -H "X-Organization-ID: $MODULEX_ORG_ID"

runs = await client.executions.list_runs(
    workflow_id="550e8400-e29b-41d4-a716-446655440000",
    limit=20,
)
for row in runs["runs"]:
    print(row["run_id"], row["status"])  # e.g. "succeeded"

const runs = await client.workflowRuns.list({
  workflowId: '550e8400-e29b-41d4-a716-446655440000',
  limit: 20,
});
for (const row of runs.runs) {
  console.log(row.run_id, row.status); // e.g. "succeeded"
}