什么是copy.ai的GTM AI平臺?

什么是copy.ai的GTM AI平臺接口？

copy.ai的GTM AI平臺有哪些核心功能？

copy.ai的GTM AI平臺的核心優勢是什么？

在哪些場景會用到copy.ai的GTM AI平臺？

我們的工作流 API 允許您將 any 工作流用作 API。 您可以觸發工作流運行，獲取工作流運行詳情，并為工作流事件（例如當工作流運行完成時）注冊網絡鉤子。

所有 API 路由均應通過 https://api.copy.ai/api/ 訪問，并需要 x-copy-ai-api-key 標頭字段。

更多信息請參閱 Authentication 頁面。

許多 API 端點都需要workflow_id 。

您可以在任何工作流的 API 標簽中的 Use as API 部分找到工作流 ID。

workflow_id 顯示在 API 端點字段的 URL 中。 它通常以 WFCG- 開始。
Workspace API 密鑰只對具有 Workspace 管理員或 Workspace 所有者角色的用戶可見。

要注冊網絡鉤子，請向 https://api.copy.ai/api/webhook 發送 POST 請求，請求的 JSON 主體包含網絡鉤子 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，您將收到工作區中所有工作流的事件。

要了解有關網絡鉤子的更多信息，請訪問注冊網絡鉤子頁面。

要啟動工作流運行，請向 <https://api.copy.ai/api/workflow/><workflow_id>/run 發送 POST 請求，請求中應包含運行起始值的 JSON 主體。

例如

{ "startVariables": { "Input 1": "", "Input 2": "" }, "metadata": { "api": true /* example optional metadata to set on the workflow run */ } }

您將收到包含已啟動工作流運行 ID 的響應： 

{ "status": "success", "data": { "id": "" } }

要跟蹤工作流的運行，請向 <https://api.copy.ai/api/workflow/><workflow_id>/run/<run_id> 發送 GET 請求。 您將收到以下格式的響應：

{
    "status": "success",
    "data":
    {
        "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": "",
						"Output 2": ""
        },
        "createdAt": "2022-11-18T20:30:07.434Z"
    }
}

運行完成后，狀態將更改為 COMPLETE 并且我們將向任何已注冊以接收工作流完成事件的 webhooks 發送 POST 請求。

請求示例：

{
    "type": "workflowRun.completed",
    "workflowRunId": "",
    "workflowId": "",
    "result":
    {
      "Output 1": "",
			"Output 2": ""
    },
    "metadata":
    {
      /* any metadata set on the workflow run */
    },
    "credits": 2 
}

要了解有關注冊 Webhook 的更多信息，請參閱此頁面： 注冊 Webhook

詳情參考：https://docs.copy.ai/docs/getting-started