Skip to main content

WorkflowStructureEntrypoint

idstringrequired

Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$

titlestringrequired

Possible values: non-empty

descriptionstring
workflowNamestringrequired
execution objectrequired
kindstringrequired
Constant value: sequence
location object
property name*any
childrenobject[]required
params object[]
  • Array [
  • namestringrequired
    flagstring
    shortFlagstring
    typestringrequired

    Possible values: [string, number, boolean, positional, file]

    requiredboolean
    labelstring
    descriptionstring
    defaultValuestring
    multipleboolean
    controlstring

    Shared form control hint. Date-related controls keep string values: date uses YYYY-MM-DD, time uses HH:mm:ss, datetime uses local YYYY-MM-DDTHH:mm:ss, and date-range uses inclusive YYYY-MM-DD/YYYY-MM-DD. Date controls do not support panel=quick.

    Possible values: [text, textarea, radio, select, checkboxes, date, time, datetime, date-range]

    panelstring

    Possible values: [main, auxiliary, quick]

    resolveOnInputboolean

    Whether main composer input changes trigger the selected entrypoint resolver (or the Conversation executor resolver). Defaults to false.

    options object[]
  • Array [
  • valuestringrequired
    labelstring
    descriptionstring
  • ]
  • acceptstring[]
    formatstring

    Possible values: [json]

  • ]
  • paramResolver object
    enabledbooleanrequired
    Constant value: true
    toolsobject[]
    tokenUsage object
    property name*any
    registryobject[]
    WorkflowStructureEntrypoint
    {
    "id": "string",
    "title": "string",
    "description": "string",
    "workflowName": "string",
    "execution": {
    "kind": "sequence",
    "location": {},
    "children": [
    {}
    ]
    },
    "params": [
    {
    "name": "string",
    "flag": "string",
    "shortFlag": "string",
    "type": "string",
    "required": true,
    "label": "string",
    "description": "string",
    "defaultValue": "string",
    "multiple": true,
    "control": "text",
    "panel": "main",
    "resolveOnInput": true,
    "options": [
    {
    "value": "string",
    "label": "string",
    "description": "string"
    }
    ],
    "accept": [
    "string"
    ],
    "format": "json"
    }
    ],
    "paramResolver": {
    "enabled": true
    },
    "tools": [
    {}
    ],
    "tokenUsage": {},
    "registry": [
    {}
    ]
    }