这个页面将帮助你开始执行工作流运行。
要开始运行一个工作流，发送一个POST请求到 https://api.copy.ai/api/workflow/<workflow_id>/run ，请求体为包含运行起始值的JSON数据。

开始工作流程运行

要启动工作流程运行，请发送 POST 请求，其中包含包含运行起始值的 JSON 正文。<https://api.copy.ai/api/workflow/><workflow_id>/run

例如：

JSON

{
  "startVariables": {
	  "Input 1": "<Inputs vary depending on the workflow used.>",
	  "Input 2": "<The best way to see an example is to try it!>"
	},
	"metadata": {
    "api": true  /* example optional metadata to set on the workflow run */
	}
}

您将收到包含已启动工作流程运行的 ID 的响应：

JSON

{
  "status": "success",
  "data": {
    "id": "<run_id>"
  }
}

此 ID 可用于跟踪工作流运行的进度，并且在运行完成时也将包含在 Webhook 请求中。

跟踪/民意调查进度

要跟踪工作流程运行，请将 GET 请求发送到。您将收到以下格式的回复：<https://api.copy.ai/api/workflow/><workflow_id>/run/<run_id>

JSON

{
    "status": "success",
    "data":
    {
        "id": "<run_id>",
        "input":
        { 
          	"Input 1": "Inputs vary depending on the workflow used.",
			      "Input 2": "The best way to see an example is to try it!" 
        },
        "status": "PROCESSING",
        "output":
        {
            "Output 1": "<Outputs vary depending on the workflow used.>",
						"Output 2": "<The best way to see an example is to try it!>"
        },
        "createdAt": "2022-11-18T20:30:07.434Z"
    }
}

要了解有关工作流程运行详细信息和可用状态的更多信息，请访问此页面：获取工作流程运行

运行完成

运行完成后，状态将更改为，我们将向任何已注册以接收工作流完成事件的 Webhook 发送 POST 请求。COMPLETE

请求示例：

JSON

{
    "type": "workflowRun.completed",
    "workflowRunId": "<run_id>",
    "workflowId": "<workflow_id>",
    "result":
    {
      "Output 1": "<Outputs vary depending on the workflow used.>",
			"Output 2": "<The best way to see an example is to try it!>"
    },
    "metadata":
    {
      /* any metadata set on the workflow run */
    },
    "credits": 2 
}

要了解有关注册 Webhook 的更多信息，请参阅此页面：注册 Webhook