概述

我们的工作流程 API 允许您将任何工作流程用作API。您可以触发工作流运行、获取工作流运行详细信息以及注册工作流事件的 Webhook（例如工作流运行完成时）

验证

所有 API 路由均应通过https://api.copy.ai/api/访问，并且需要标头字段:x-copy-ai-api-key

请参阅身份验证页面了解更多信息。

查找您的工作流程 ID

许多 API 端点需要:workflow_id

您可以通过转至 “用作 API”部分中任意工作流上的API选项卡来查找工作流 ID 。

workflow_id显示在API端点字段的URL中。它通常以PKGW-开头。

网络钩子注册

要注册 webhook，请向发送 POST 请求https://api.copy.ai/api/webhookJSON 主体包含您的webhook URL、要通知的事件类型以及可选的工作流ID。

例如：

{
  "url": "<https://mywebsite.com/webhook>",
  "eventType": "workflowRun.completed",
  "workflowId": "<my-workflow-id>"
}

您将收到包含您注册的 webhook 详细信息的响应：

{
  "status": "success",
  "data": {
    "id": "<id of webhook>",
    "url": "<https://mywebsite.com/webhook>",
    "eventType": "workflowRun.completed",
    "workflowId": "<my-workflow-id>"
  }
}

注意： 如果未包含工作流程 ID，您将收到工作区中所有工作流程的事件。

要了解有关 Webhook 的更多信息，请访问注册 Webhook页面。

开始工作流程运行

要启动工作流运行，请向发送 POST 请求<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 的响应：

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

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

跟踪/民意调查进度

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

{
    "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"
    }
}

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

运行完成

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

请求示例：

{
    "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