Interface ToolWorkflowV1NodeParameters

Source
interface ToolWorkflowV1NodeParameters {
    description?: string;
    fields?: {
        values: {
            arrayValue?: string;
            booleanValue?: "true" | "false";
            name?: string;
            numberValue?: string;
            objectValue?: string;
            stringValue?: string;
            type?:
                | "stringValue"
                | "numberValue"
                | "booleanValue"
                | "arrayValue"
                | "objectValue";
        }[];
    };
    inputSchema?: string;
    jsonSchemaExample?: string;
    name?: string;
    responsePropertyName?: string;
    schemaType?: "manual"
    | "fromJson";
    source?: "database" | "parameter";
    specifyInputSchema?: boolean;
    workflowId?: string;
    workflowJson?: string;
}

Properties§

Source§

readonly description?: string

Type options: {"rows":3}

Source§

readonly fields?: {
    values: {
        arrayValue?: string;
        booleanValue?: "true" | "false";
        name?: string;
        numberValue?: string;
        objectValue?: string;
        stringValue?: string;
        type?:
            | "stringValue"
            | "numberValue"
            | "booleanValue"
            | "arrayValue"
            | "objectValue";
    }[];
}

These will be output by the 'execute workflow' trigger of the workflow being called Default: {} Type options: {"multipleValues":true,"sortable":true}

Source§

readonly inputSchema?: string

Schema to use for the function Default: "{\n"type": "object",\n"properties": {\n\t"some_input": {\n\t\t"type": "string",\n\t\t"description": "Some input to the function"\n\t\t}\n\t}\n}" Type options: {"rows":10}

Source§

readonly jsonSchemaExample?: string

Example JSON object to use to generate the schema Default: "{\n\t"some_input": "some_value"\n}" Type options: {"rows":10}

Source§

readonly name?: string

Source§

readonly responsePropertyName?: string

Where to find the data that this tool should return. n8n will look in the output of the last-executed node of the workflow for a field with this name, and return its value. Default: "response"

Source§

readonly schemaType?: "manual" | "fromJson"

How to specify the schema for the function Default: "fromJson"

Source§

readonly source?: "database" | "parameter"

Where to get the workflow to execute from Default: "database"

Source§

readonly specifyInputSchema?: boolean

Whether to specify the schema for the function. This would require the LLM to provide the input in the correct format and would validate it against the schema.

Source§

readonly workflowId?: string

The workflow to execute

Source§

readonly workflowJson?: string

The workflow JSON code to execute Default: "\n\n\n\n\n\n\n\n\n" Type options: {"rows":10}