Skip to main content

ToolUpdate

Payload used to update Tool. Optional fields include name, alias, description, type, function, and 7 more.

name object
anyOf
string
alias object
anyOf
string
description object
anyOf
string
type object
anyOf
string

Possible values: [python, agent, workflow]

function object
anyOf
sourceSource (string)required
inputs object
property name*any
Default value: {}
outputs object
property name*any
Default value: {}
dependenciesstring[]
Default value: []
decorators object[]

Decorator bindings declared in configuration. Configured bindings take precedence over source bindings with the same kind and name; an empty list uses source bindings only.

  • Array [
  • decoratorDecorator (string)required

    Decorator name, such as use_connector or use_llm. The name must identify a supported decorator.

    nameName (string)required

    Binding variable name injected into the namespace

    arguments object

    Decorator arguments, e.g. {'ref':...} or {'model':...}

    property name*any

    Decorator arguments, e.g. {'ref':...} or {'model':...}

  • ]
  • ref object
    anyOf
    string
    collection_id object
    anyOf
    string

    Possible values: non-empty

    folder_id object
    anyOf
    string
    tags object
    anyOf
  • Array [
  • string
  • ]
  • require_browser object
    anyOf
    boolean
    examples object
    anyOf
  • Array [
  • description object
    anyOf
    string
    arguments objectrequired
    property name*any
  • ]
  • options object
    anyOf
    object
    ToolUpdate
    {
    "name": "string",
    "alias": "string",
    "description": "string",
    "type": "python",
    "function": {
    "source": "string",
    "inputs": {},
    "outputs": {},
    "dependencies": [
    "string"
    ],
    "decorators": [
    {
    "decorator": "string",
    "name": "string",
    "arguments": {}
    }
    ]
    },
    "ref": "string",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "require_browser": true,
    "examples": [
    {
    "description": "string",
    "arguments": {}
    }
    ],
    "options": {}
    }