Class WorkflowResource

constructor

• new WorkflowResource(http: HttpClient): WorkflowResource

  Parameters

  • http: HttpClient

  Returns WorkflowResource

Readonlyevents

Readonlyexpressions

Readonlygraph

Readonlynode_types

Readonlysample

commands

• commands(): Promise<Command[]>

  List available workflow commands Returns the full set of workflow commands registered with the workflow host. Commands represent discrete operations that a workflow node can invoke — each carries its own input and output schemas used by the workflow builder. This endpoint requires a valid developer session. The list is not paginated; all registered commands are returned in a single response.

  Returns Promise<Command[]>

  Array of all registered workflow command definitions.

llmTxt

• llmTxt(): Promise<{ content: ArrayBuffer; mimeType: string }>

  Retrieve the workflow-authoring LLM prompt Returns the plain-text system prompt used by workflow-authoring assistants. The prompt is rendered from the registered node types and commands so its authoring guidance stays synchronized with the running platform.

  Returns Promise<{ content: ArrayBuffer; mimeType: string }>

  Plain-text system prompt for workflow-authoring assistants.

run

• run(
      input: {
          context?: Record<string, unknown>;
          env?: Record<string, unknown>;
          graph?: Record<string, unknown>;
          node?: Record<string, unknown>;
          payload?: Record<string, unknown>;
          run_as_agent?: string;
          run_as_user?: string;
      },
  ): Promise<
      {
          context?: Record<string, unknown>;
          env?: Record<string, unknown>;
          error?: string;
          files?: Record<string, unknown>[];
          log?: string[];
          nextNodeId?: string;
          output?: unknown;
          payload?: unknown;
          records?: Record<string, unknown>[];
          startNodeId?: string;
          status?: string;
          wait?: Record<string, unknown>;
      },
  >

  Execute a workflow node or graph Executes a single workflow node or a complete workflow graph and returns the result. Supply either node (to run one node in isolation) or graph (to execute a full directed graph); the two parameters are mutually exclusive and exactly one must be provided. The authenticated developer is used as the default workflow principal for entitlement checks on billable operations such as LLM calls. Supply run_as_user or run_as_agent to override the acting identity for the execution — at most one override may be set per request. Execution errors are logged to the activity feed under the acting identity so they appear alongside automation-driven workflow errors in operator dashboards. A 422 response is returned when execution fails; the response body includes the error message and any partial records produced before the failure.

  Parameters

  • input: {
        context?: Record<string, unknown>;
        env?: Record<string, unknown>;
        graph?: Record<string, unknown>;
        node?: Record<string, unknown>;
        payload?: Record<string, unknown>;
        run_as_agent?: string;
        run_as_user?: string;
    }

    Request body.

    • Optionalcontext?: Record<string, unknown>

      Additional execution context made available to workflow nodes at runtime. Merged with the authenticated viewer context set by the platform. Defaults to an empty object if omitted.

    • Optionalenv?: Record<string, unknown>

      Evaluator environment variables injected into expression contexts during execution. The platform automatically merges developer-tier runtime env vars before evaluation. Defaults to an empty object if omitted.

    • Optionalgraph?: Record<string, unknown>

      A complete workflow graph to execute. Must be an object conforming to the WorkflowGraph schema (keys: start_node, nodes, etc.). Mutually exclusive with node — supply exactly one.

    • Optionalnode?: Record<string, unknown>

      A single workflow node to execute in isolation. Must be an object with at minimum a type key identifying the node kind, plus any node-specific configuration values. Mutually exclusive with graph — supply exactly one.

    • Optionalpayload?: Record<string, unknown>

      Arbitrary input data passed into the workflow as the initial payload. Defaults to an empty object if omitted.

    • Optionalrun_as_agent?: string

      Agent ID (agt_...) of the agent to impersonate for the execution. When set, workflow nodes run with this agent as the acting principal instead of the authenticated developer. The agent must belong to the current app. Mutually exclusive with run_as_user. null by default (runs as the authenticated developer).

    • Optionalrun_as_user?: string

      User ID (usr_...) of the user to impersonate for the execution. When set, workflow nodes run with this user as the acting principal instead of the authenticated developer. Mutually exclusive with run_as_agent. null by default (runs as the authenticated developer).

  Returns Promise<
      {
          context?: Record<string, unknown>;
          env?: Record<string, unknown>;
          error?: string;
          files?: Record<string, unknown>[];
          log?: string[];
          nextNodeId?: string;
          output?: unknown;
          payload?: unknown;
          records?: Record<string, unknown>[];
          startNodeId?: string;
          status?: string;
          wait?: Record<string, unknown>;
      },
  >

  Successful response