Skip to main content

CreateWorkflowProjectRequest

workflowIdstring<uuid>required

Required UUID from local package.json.id; used as the server project primary key.

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

projectInfo objectrequired

Authoritative project metadata model. Legacy read responses may carry null dataStorage; create and save requests use DeclaredWorkflowProjectInfo with an explicit valid mode. Current clients recognize zh-CN, en, multilingual, multiplatform, macos, windows, and web; future locale and identifier values that match the contract are preserved unchanged.

localizedNames objectrequired
property name*string
declarationsstring[]required

Possible values: Value must match regular expression ^[a-z][a-z0-9-]*$

platformSupport objectrequired
oneOf
modestringrequired
Constant value: agnostic
dataStorage objectrequired

Strictly limits accessible data locations; null represents an undeclared legacy project only.

oneOf
modestringrequired

local permits local storage only, server permits server storage only, and both permits an explicit choice.

Possible values: [both, local, server]

relatedProjects object[]required

Possible values: <= 32

  • Array [
    • aliasstringrequired

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

    projectIdstring<uuid>required
    grantToRelatedProject objectrequired

    Rules allowing the related project to access the current project's KV; not the current project's permission on the target.

    read objectrequired
    oneOf
    modestringrequired
    Constant value: none
    write objectrequired
    oneOf
    modestringrequired
    Constant value: none
  • ]
    • visibilityWorkflowVisibility

    Possible values: [private, public]

    projectCard object
    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}$

    CreateWorkflowProjectRequest
    {
      "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "projectType": "workflow",
      "projectInfo": {
        "localizedNames": {},
        "declarations": [
          "string"
        ],
        "platformSupport": {
          "mode": "agnostic"
        },
        "dataStorage": {
          "mode": "local"
        },
        "relatedProjects": [
          {
            "alias": "string",
            "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "grantToRelatedProject": {
              "read": {
                "mode": "none"
              },
              "write": {
                "mode": "none"
              }
            }
          }
        ]
      },
      "visibility": "private",
      "projectCard": {
        "icon": "workflow",
        "iconUrl": "string",
        "iconColor": "string",
        "iconBackgroundColor": "string"
      }
    }