openclaw-voc-skill/openclaw-skills/jimeng/jimeng-task-query/api-config.json

{
  "name": "jimeng-task-query",
  "displayName": "即梦任务结果查询",
  "description": "查询即梦AI生成任务状态，轮询获取图片/视频生成结果，支持所有即梦生成接口的结果查询。",
  "category": "jimeng",
  "version": "1.0.0",
  "endpoint": {
    "method": "POST",
    "url": "https://server.fmode.cn/api/volcengine/jimeng/getDataByTask02",
    "headers": {
      "Content-Type": "application/json"
    }
  },
  "parameters": {
    "type": "object",
    "required": [
      "routerName",
      "token"
    ],
    "properties": {
      "workId": {
        "type": "string",
        "description": "ImagineWork数据id，与taskId二选一"
      },
      "taskId": {
        "type": "string",
        "description": "任务ID，与workId二选一"
      },
      "routerName": {
        "type": "string",
        "description": "对应接口名称，首次获取资源必填",
        "enum": [
          "getClothesV2",
          "getImgByImg",
          "getImgV4",
          "getText2ImgV3",
          "getText2ImgV31",
          "getImg2ImgV3",
          "getImgV4_pod",
          "getImgV4_goods",
          "getInpaint",
          "getSuperResolution",
          "getVideoV3_720p",
          "getVideoV3_1080p",
          "getVideoV3_Pro",
          "getActor",
          "getActorV2"
        ]
      },
      "logo_info": {
        "type": "object",
        "description": "水印信息（选填）",
        "properties": {
          "add_logo": {
            "type": "boolean",
            "description": "是否添加水印",
            "default": false
          },
          "position": {
            "type": "integer",
            "description": "水印位置: 0右下/1左下/2左上/3右上",
            "default": 0
          },
          "language": {
            "type": "integer",
            "description": "0中文/1英文",
            "default": 0
          },
          "opacity": {
            "type": "number",
            "description": "不透明度[0,1]",
            "default": 1
          },
          "logo_text_content": {
            "type": "string",
            "description": "自定义水印文本"
          }
        }
      },
      "token": {
        "type": "string",
        "description": "认证token，格式: Bearer r:xxxxxxxx"
      }
    }
  },
  "requestTransform": {
    "template": {
      "workId": "{{workId}}",
      "taskId": "{{taskId}}",
      "routerName": "{{routerName}}",
      "logo_info": "{{logo_info}}",
      "token": "{{token}}"
    }
  },
  "response": {
    "type": "object",
    "properties": {
      "code": {
        "type": "integer",
        "description": "响应状态码，200表示成功"
      },
      "data": {
        "type": "object",
        "properties": {
          "tip": {
            "type": "string",
            "description": "状态提示文字"
          },
          "isFinish": {
            "type": "boolean",
            "description": "true表示任务完成"
          }
        }
      }
    }
  },
  "notes": "轮询策略：每3-5秒调用一次，直到 data.isFinish=true。任务完成后查询 ImagineWork 表获取 images/videos 字段。",
  "usageExamples": [
    {
      "name": "查询图片生成任务状态",
      "input": {
        "workId": "82CC78HNl6",
        "routerName": "getImgV4",
        "token": "Bearer r:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
      },
      "description": "查询 getImgV4 图片生成任务的完成状态"
    }
  ],
  "pollingConfig": {
    "intervalMs": 3000,
    "maxAttempts": 60,
    "completionCondition": "data.isFinish === true"
  },
  "timeout": 15000,
  "retry": {
    "maxAttempts": 3,
    "delay": 1000,
    "backoffMultiplier": 2
  },
  "tokenConfig": {
    "type": "bearer",
    "configFile": "~/.openclaw/voc-credentials.json",
    "tokenField": "vocToken",
    "resolutionOrder": [
      "configFile"
    ],
    "apigId": "Vo3ROWEvDy",
    "paymentUrlResolution": {
      "description": "动态构建充值URL：在已存在 session token 时查出用户 objectId，拼接到专属充值页面",
      "steps": [
        "1. 从 voc-credentials.json 获取当前 session token",
        "2. 调用 GET https://server.fmode.cn/parse/users/me （Header: X-Parse-Application-Id: ncloudmaster, X-Parse-Session-Token: {token}）获取用户 objectId",
        "3. 拼接充值URL: https://app.fmode.cn/dev/apig-pay/?user={objectId}&apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
        "4. 将该URL展示给用户，引导扫码支付"
      ],
      "userResolveEndpoint": "https://server.fmode.cn/parse/users/me",
      "userResolveHeaders": {
        "X-Parse-Application-Id": "ncloudmaster",
        "X-Parse-Session-Token": "{vocToken}"
      },
      "paymentBaseUrl": "https://app.fmode.cn/dev/apig-pay/",
      "paymentParams": {
        "user": "{resolvedUserId}",
        "apigid": "Vo3ROWEvDy",
        "fun_id": "HOkkX72PMF"
      },
      "balanceCheckEndpoint": "https://server.fmode.cn/api/apig/getApig"
    },
    "onMissing": {
      "action": "showPaymentQR",
      "qrCodeUrl": "https://app.fmode.cn/dev/apig-pay/?apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
      "title": "扫码开通 VOC-AI 数据服务",
      "message": "此 Skill 需要有效的 API Token。请先打开充值页面完成登录和充值；当用户提供 session token 后，请由 OpenClaw 运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json 的 vocToken 字段，再重试当前 Skill。",
      "tokenSetupCommandTemplate": "node scripts/tools/set-voc-token.js {sessionToken}",
      "tokenSetupInstructions": "当用户完成登录和充值后，如果用户把 session token 发给你，请直接运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json，然后重试当前 Skill。"
    },
    "onBalanceInsufficient": {
      "action": "resolveUserThenShowPayment",
      "title": "VOC-AI Token 余额不足，请扫码充值",
      "message": "当前 Token 余额不足，我将为你生成专属充值链接，扫码支付后即可继续使用。"
    }
  },
  "errorHandling": {
    "balanceInsufficient": {
      "conditions": [
        {
          "responseField": "code",
          "operator": "in",
          "value": [
            -2,
            -3,
            -10,
            402,
            429
          ]
        },
        {
          "responseField": "msg",
          "operator": "contains",
          "value": [
            "余额不足",
            "insufficient",
            "balance",
            "quota",
            "没有开通",
            "权限或余额"
          ]
        },
        {
          "responseField": "mess",
          "operator": "contains",
          "value": [
            "余额不足",
            "insufficient",
            "balance",
            "quota",
            "没有开通",
            "权限或余额"
          ]
        },
        {
          "responseField": "message",
          "operator": "contains",
          "value": [
            "余额不足",
            "insufficient",
            "balance",
            "没有开通",
            "权限或余额"
          ]
        }
      ],
      "matchMode": "any",
      "trigger": "tokenConfig.onBalanceInsufficient"
    },
    "unauthorized": {
      "conditions": [
        {
          "responseField": "code",
          "operator": "in",
          "value": [
            401,
            403
          ]
        },
        {
          "responseField": "msg",
          "operator": "contains",
          "value": [
            "unauthorized",
            "token",
            "invalid",
            "auth"
          ]
        }
      ],
      "matchMode": "any",
      "trigger": "tokenConfig.onMissing"
    }
  }
}