NodeFox logoNodeFox

SDK Reference

Overview

SDK clients are useful when application code needs typed interaction with NodeFox workflows.

Core operations

Most SDK usage follows three operations:

  1. Trigger run
  2. Check run status
  3. Retrieve run output or trace

Typical invocation pattern

const run = await client.workflows.run({
  workflowId: "customer-support-triage",
  input: payload,
});

const status = await client.runs.get(run.id);

Integration guidance

  • Wrap SDK calls in your own service boundary
  • Propagate correlation IDs into run metadata
  • Handle async run completion for long workflows
  • Store minimal run references needed for user-facing status

Error handling

Treat errors in two categories:

  • Invocation errors: request auth/shape/network issues
  • Workflow errors: business logic or dependency failures during execution

Both should be logged distinctly for faster triage.