WorkflowSummary

idstringrequired

Project UUID, which is also the server permission and upload verification boundary.

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]

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

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

object

modestringrequired

Constant value: agnostic

dataStorage objectrequired

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

oneOf

WorkflowProjectDataStorage

modestringrequired

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

Possible values: [local, server, both]

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

object

modestringrequired

Constant value: none

write objectrequired

oneOf

object

modestringrequired

Constant value: none

]

ownerUserIdstring

visibilityWorkflowVisibilityrequired

Possible values: [private, public]

createdByUserIdstring

createdByProfile object

userIdstringrequired

displayNamestringrequired

emailstring

Optional email address for the profile summary.

avatarUrlstring

Optional avatar image URL or data URL for the uploader profile.

createdAtstring<date-time>

updatedAtstring<date-time>

hasDraftbooleanrequired

lateststring | nullnullablerequired

Newest online release; it is not necessarily Server-runnable or compatible with the current Desktop platform.

versionsstring[]required

onlineVersionsstring[]required

serverRunnableVersionsstring[]required

Online versions with Server enabled, a runtime artifact present, and compatible Core metadata.

latestServerRunnablestring | nullnullablerequired

Newest Server-runnable version, or null when none is compatible.

nextVersionstringrequired

runQueue object

acceptsNewRunsbooleanrequired

concurrencyintegerrequired

Possible values: >= 1

Default value: 3

updatedAtstring<date-time>required

draftBuild object

statusstringrequired

Possible values: [success, failed]

startedAtstring<date-time>required

endedAtstring<date-time>required

durationMsnumberrequired

stdoutstringrequired

stderrstringrequired

errorstring

sourceDownload object

allowedbooleanrequired

Whether the current identity has the permission to download the project source code.

availablebooleanrequired

Whether the latest version retains the original source code.

targetstring | nullnullablerequired

sourceMode objectrequired

oneOf

WorkflowVersionSourceMode

bundled keeps only the bundle/minify products;source keeps the original source code snapshot.

WorkflowVersionSourceMode

bundled keeps only the bundle/minify products;source keeps the original source code snapshot.

Possible values: [bundled, source]

WorkflowSummary

{
  "id": "string",
  "name": "string",
  "projectType": "workflow",
  "projectCard": {
    "icon": "workflow",
    "iconUrl": "string",
    "iconColor": "string",
    "iconBackgroundColor": "string"
  },
  "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"
          }
        }
      }
    ]
  },
  "ownerUserId": "string",
  "visibility": "private",
  "createdByUserId": "string",
  "createdByProfile": {
    "userId": "string",
    "displayName": "string",
    "email": "string",
    "avatarUrl": "string"
  },
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "hasDraft": true,
  "latest": "string",
  "versions": [
    "string"
  ],
  "onlineVersions": [
    "string"
  ],
  "serverRunnableVersions": [
    "string"
  ],
  "latestServerRunnable": "string",
  "nextVersion": "string",
  "runQueue": {
    "acceptsNewRuns": true,
    "concurrency": 3,
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "draftBuild": {
    "status": "success",
    "startedAt": "2024-07-29T15:51:28.071Z",
    "endedAt": "2024-07-29T15:51:28.071Z",
    "durationMs": 0,
    "stdout": "string",
    "stderr": "string",
    "error": "string"
  },
  "sourceDownload": {
    "allowed": true,
    "available": true,
    "target": "string",
    "sourceMode": "bundled"
  }
}