Skip to main content

SummaryResponse

errCodeintegerrequired
Constant value: 0
errMessagestringrequired
Constant value:
data objectrequired
idstringrequired

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

namestringrequired
projectTypeProjectKindrequired

All project types are declared by the static package.json.steamHarness.projectType field. Server reads metadata without loading project code.

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 DeclaredProjectInfo 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: [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
    modestringrequired
    Constant value: none
    write objectrequired
    oneOf
    modestringrequired
    Constant value: none
  • ]
    • ownerUserIdstring
    visibilityVisibilityrequired

    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

    Latest immutable published source version.

    versionsstring[]required
    nextVersionstringrequired
    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
    canManageboolean

    Whether the current account can manage this project.

    canWriteDataboolean

    Whether the current account can write project data.

    SummaryResponse
    {
      "errCode": 0,
      "errMessage": "string",
      "data": {
        "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"
        ],
        "nextVersion": "string",
        "sourceDownload": {
          "allowed": true,
          "available": true,
          "target": "string"
        },
        "canManage": true,
        "canWriteData": true
      }
    }