WorkflowEmbedSiteInfo

workflowIdstringrequired

workflowNamestringrequired

titlestringrequired

descriptionstringrequired

targetstringrequired

resolvedTargetstringrequired

projectTypeWorkflowProjectTyperequired

Workflow/Conversation is declared by executor.projectType;Kanban is declared package.json.workflowCode.projectType declaration. This allows the host to choose a running or static preview interface.

Possible values: [workflow, conversation, kanban]

projectCard objectrequired

iconstringrequired

Possible values: [workflow, message-circle, bot, sparkles, code, git-branch, boxes, zap, database, file-text, cpu, brain]

iconUrlstring<uri>

Optional image URL used instead of the icon token. New Desktop uploads use the Server-generated /project-card-images/... WebP URL; existing external http(s) values remain readable for backward compatibility.

iconColorstring

Optional built-in icon foreground color. Defaults to white for older metadata.

Possible values: Value must match regular expression ^#[0-9a-fA-F]{6}$

iconBackgroundColorstringrequired

Possible values: Value must match regular expression ^#[0-9a-fA-F]{6}$

viewer object

userIdstring

displayNamestring

emailstring<email>

avatarUrlstring

tokenUsage object

property name*any

params object[]required

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]

]

structure objectrequired

workflowIdstringrequired

workflowNamestringrequired

targetstringrequired

resolvedTargetstringrequired

structure objectrequired

projectTypeWorkflowProjectTyperequired

Workflow/Conversation is declared by executor.projectType;Kanban is declared package.json.workflowCode.projectType declaration. This allows the host to choose a running or static preview interface.

Possible values: [workflow, conversation, kanban]

workflow objectrequired

property name*any

definitions objectrequired

Project-level nodes, API calls, variables, and registry static definitions.

property name*any

Project-level nodes, API calls, variables, and registry static definitions.

diagnostics objectrequired

Project-level warnings and violations.

property name*any

Project-level warnings and violations.

defaultEntrypointstring

Returns only Workflow; must hit one of entrypoints.

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

entrypoints object[]

Only Workflow returns the flat independent entry directory in the same order as the source declaration.

Possible values: >= 1

Array [

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

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[]

]

schedulePresets object[]

Only Workflow can declare the proposed plan; the host must be created by user confirmation after presentation and is not automatically enabled.

Possible values: <= 20

Array [

idstringrequired

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

titlestringrequired

Possible values: non-empty and <= 100 characters

descriptionstring

Possible values: <= 500 characters

entrypointIdstringrequired

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

timezonestringrequired

trigger objectrequired

kind stringrequired

Possible values: [WorkflowScheduleWindowIntervalTrigger, WorkflowScheduleCronTrigger]

WorkflowScheduleWindowIntervalTrigger
WorkflowScheduleCronTrigger

weekdaysinteger[]required

Monday to Sunday correspond to 1 to 7.

Possible values: >= 1

windows object[]required

Local time windows that do not overlap, with start and end times included in the trigger range.

Possible values: >= 1, <= 12

Array [

startstringrequired

Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

endstringrequired

Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

]

intervalMinutesintegerrequired

Possible values: >= 1 and <= 1440

expressionstringrequired

5 field Cron, interpreted timezone scheduled.

Example: */5 9-15 * * 1-5

paramValues objectrequired

property name*any

]

execution object

Conversation single-entry execution structure;Workflow does not return this top-level compatible field.

kindstringrequired

Constant value: sequence

location object

property name*any

childrenobject[]required

params object[]

Conversation executor parameters;Workflow parameters in each entrypoint.

Array [

namestringrequired

flagstring

shortFlagstring

typestringrequired

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

requiredboolean

labelstring

descriptionstring

defaultValuestring

multipleboolean

controlstring

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

property name*any

toolsobject[]

Conversation executor tools;Workflow tools are located in each entrypoint.

tokenUsage object

property name*any

registryobject[]

kanban object

Kanban static artifact boundary.

artifactDirstringrequired

Static product directory relative to the project root; old projects default ..

Example: dist

entrystringrequired

Relative artifactDir HTML entry; default index.html.

Example: index.html

manifest object

versionintegerrequired

Constant value: 1

params object[]required

Array [

namestringrequired

flagstring

shortFlagstring

typestringrequired

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

requiredboolean

labelstring

descriptionstring

defaultValuestring

multipleboolean

controlstring

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]

]

property name*any

kanban object

Inventory, user quarantine configuration, and static preview information returned only when projectType: kanban.

artifactDirstringrequired

entrystringrequired

manifest object

versionintegerrequired

Constant value: 1

params object[]required

Array [

namestringrequired

flagstring

shortFlagstring

typestringrequired

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

requiredboolean

labelstring

descriptionstring

defaultValuestring

multipleboolean

controlstring

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]

]

configurations object[]required

Array [

idstring<uuid>required

namestringrequired

values objectrequired

Host-persisted form string value; converted to JSON native value by parameter definition when injected into the page.

property name*string

createdAtstring<date-time>required

updatedAtstring<date-time>required

]

activeConfigurationIdstring<uuid>

preview objectrequired

noncestringrequired

urlstringrequired

expiresAtstring<date-time>

The expiration time of the Studio or Embed short-term static preview capability; the host will automatically renew before expiration.

WorkflowEmbedSiteInfo
{
  "workflowId": "string",
  "workflowName": "string",
  "title": "string",
  "description": "string",
  "target": "string",
  "resolvedTarget": "string",
  "projectType": "workflow",
  "projectCard": {
    "icon": "workflow",
    "iconUrl": "string",
    "iconColor": "string",
    "iconBackgroundColor": "string"
  },
  "viewer": {
    "userId": "string",
    "displayName": "string",
    "email": "user@example.com",
    "avatarUrl": "string"
  },
  "tokenUsage": {},
  "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"
    }
  ],
  "structure": {
    "workflowId": "string",
    "workflowName": "string",
    "target": "string",
    "resolvedTarget": "string",
    "structure": {
      "projectType": "workflow",
      "workflow": {},
      "definitions": {},
      "diagnostics": {},
      "defaultEntrypoint": "string",
      "entrypoints": [
        {
          "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": [
            {}
          ]
        }
      ],
      "schedulePresets": [
        {
          "id": "string",
          "title": "string",
          "description": "string",
          "entrypointId": "string",
          "timezone": "string",
          "trigger": {
            "kind": "window-interval",
            "weekdays": [
              0
            ],
            "windows": [
              {
                "start": "string",
                "end": "string"
              }
            ],
            "intervalMinutes": 0
          },
          "paramValues": {}
        }
      ],
      "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": {},
      "tools": [
        {}
      ],
      "tokenUsage": {},
      "registry": [
        {}
      ],
      "kanban": {
        "artifactDir": "dist",
        "entry": "index.html",
        "manifest": {
          "version": 1,
          "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"
            }
          ]
        }
      }
    }
  },
  "kanban": {
    "artifactDir": "string",
    "entry": "string",
    "manifest": {
      "version": 1,
      "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"
        }
      ]
    },
    "configurations": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "values": {},
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      }
    ],
    "activeConfigurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "preview": {
      "nonce": "string",
      "url": "string",
      "expiresAt": "2024-07-29T15:51:28.071Z"
    }
  }
}