@archastro/sdk
    Preparing search index...

    Interface Command

    A workflow command that a workflow node can invoke, including its identifier, human-readable name, and JSON schemas for its inputs and outputs.

    interface Command {
        description: string;
        errorOutput?: Record<string, unknown>;
        expectedInput?: Record<string, unknown>;
        id: string;
        name: string;
        successOutput?: Record<string, unknown>;
    }
    Index

    Properties

    description errorOutput? expectedInput? id name successOutput?

    Properties

    description: string

    Human-readable description of what the command does, shown alongside the name in the workflow builder.

    errorOutput?: Record<string, unknown>

    JSON Schema describing the shape of an error output. null if the command does not produce structured error data.

    expectedInput?: Record<string, unknown>

    JSON Schema describing the input the command expects. null if the command takes no input.

    id: string

    Unique string identifier for the command, used to reference it in workflow node configurations.

    name: string

    Human-readable display name for the command shown in the workflow builder.

    successOutput?: Record<string, unknown>

    JSON Schema describing the shape of a successful output. null if the command produces no output on success.

    Settings

    Member Visibility

    On This Page

    Properties