AI Widgets

Interact with the AI Widgets service.

Actions

Steps this node can perform. Add one from Add a step, then pick the action.

List all widgets

Settings

No settings.

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Get a widget by ID

Settings

Field	Type	Required	Description
Widget ID	Text	Yes

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Create a new widget

Settings

Field	Type	Required	Description
Name	Text	Yes
Description	Text
Type	Choice	Yes	The type of the widget. Options: `KB Search`, `Tone Adjustment`, `Summarization`, `Translation`, `Explanation`, `Proof Reading`, `Reply Assistant` Default: `KB_SEARCH`

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Update a widget by ID

Settings

Field	Type	Required
Widget ID	Text	Yes
Name	Text	Yes
Description	Text

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

List all installed widget instances

Settings

Field	Type	Required	Description
Workspace ID	Text	Yes

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

List all installed widget instances by type

Settings

Field	Type	Required	Description
Workspace ID	Text	Yes
Type	Choice	Yes	The type of the widget. Options: `KB Search`, `Tone Adjustment`, `Summarization`, `Translation`, `Explanation`, `Proof Reading`, `Reply Assistant`, `Custom` Default: `KB_SEARCH`

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Install a widget instance

Settings

Field	Type	Required	Description
Workspace ID	Text	Yes
Widget ID	Text	Yes
Name	Text	Yes
Description	Text
Status	Text		The status of the widget instance. Default: `public`
Settings	Key–value pairs		JSON object for widget instance settings.

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Update the settings of a widget instance

Settings

Field	Type	Required	Description
Workspace ID	Text	Yes
Widget Instance ID	Text	Yes
Settings	Key–value pairs		JSON object for widget instance settings.

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Update a widget instance

Settings

Field	Type	Required	Description
Workspace ID	Text	Yes
Widget Instance ID	Text	Yes
Name	Text	Yes
Description	Text
Status	Text		The status of the widget instance. Default: `public`

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Uninstall a widget instance

Settings

Field	Type	Required	Description
Workspace ID	Text	Yes
Widget Instance ID	Text	Yes

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

List all custom widgets

Settings

No settings.

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Get a custom widget by ID

Settings

Field	Type	Required	Description
Widget Custom ID	Text	Yes

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Proof-reading

Proof-read a text or paragraph

Settings

Field	Type	Required	Description
Instance ID	Text	Yes
Text	Text	Yes
Use AI	Yes / No	Yes	Default: `false`
Use User Dictionary	Yes / No	Yes	Default: `false`

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Reply Assistant

Reply to a text or paragraph

Settings

Field	Type	Required	Description
Instance ID	Text	Yes
Get data from DECA Knowledge Base	Yes / No	Yes	Default: `true`
Max References	Number		Default: `5`
Text or Paragraph	Text	Yes

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Tone Adjustment

Adjust the tone of a text or paragraph

Settings

Field	Type	Required	Description
Instance ID	Text		Needed when the workspace has more than one public tone adjustment widget.
Text or Paragraph	Text	Yes
Adjust Tone	Choice	Yes	Options: `Friendly`, `Polite`, `Softer`, `Brighter`, `Long`, `Short` Default: `FRIENDLY`

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Summarization

Summarize a text or paragraph

Settings

Field	Type	Required	Description
Instance ID	Text	Yes
Text	Text	Yes

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Translation

Translate a text or paragraph

Settings

Field	Type	Required	Description
Instance ID	Text	Yes
Text	Text	Yes
Source Language	Text		The source language of the text (e.g., 'en', 'es', 'fr').
Target Language	Text	Yes	The target language for translation (e.g., 'en', 'es', 'fr').

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

Explanation

Explain a text or paragraph

Settings

Field	Type	Required	Description
Instance ID	Text	Yes
Text	Text	Yes

Output

Later steps use this data by picking this step in the $ picker. For example, result is $.<step ID>.output.result.

json

{
  "result": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`result`	JSON	The result from the API call.

AI Widgets

Actions

List Widgets

Get Widget

Create Widget

Update Widget

List Installed Widgets

List Installed Widgets by Type

Install Widget

Update Widget Instance Settings

Update Widget Instance

Uninstall Widget Instance

List Widget Customs

Get Widget Custom

Proof-reading

Reply Assistant

Tone Adjustment

Summarization

Translation

Explanation

AI Widgets ​

Actions ​

List Widgets ​

Get Widget ​

Create Widget ​

Update Widget ​

List Installed Widgets ​

List Installed Widgets by Type ​

Install Widget ​

Update Widget Instance Settings ​

Update Widget Instance ​

Uninstall Widget Instance ​

List Widget Customs ​

Get Widget Custom ​

Proof-reading ​

Reply Assistant ​

Tone Adjustment ​

Summarization ​

Translation ​

Explanation ​

AI Widgets

Actions

List Widgets

Get Widget

Create Widget

Update Widget

List Installed Widgets

List Installed Widgets by Type

Install Widget

Update Widget Instance Settings

Update Widget Instance

Uninstall Widget Instance

List Widget Customs

Get Widget Custom

Proof-reading

Reply Assistant

Tone Adjustment

Summarization

Translation

Explanation