Copy.ai
  1. 工作流程运行
Copy.ai
  • Copy.ai 工作流程 API 入门
  • API 接口
    • 身份验证
    • WEBHOOKS
      • 注册 Webhook
      • 获取 Webhook
      • 获取所有 Webhook
      • 删除 Webhook
    • 工作流程运行
      • 开始工作流程运行
        POST
      • 获取工作流运行
        GET
      • 获取所有工作流程运行
        GET
  1. 工作流程运行

获取所有工作流程运行

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
https://api.copy.ai/api/workflow/{workflow_id}/run/

你可以通过API查看某个工作流的所有运行详情。
要查看所有工作流运行,发送一个GET请求至 https://api.copy.ai/api/workflow/<workflow_id>/run。
你将收到一个响应,其中包含该工作流所有运行的详细信息。

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.copy.ai/api/workflow//run/?size=10&page=1' \
--header 'x-copy-ai-api-key: key goes here'
响应示例响应示例
200 - 成功示例
{
  "status": "success",
  "data": {
    "total": 3,
    "data": [
      {
        "metadata": {
          "interestingValue": "interestingValue"
        },
        "createdAt": "2023-09-27T18:24:47.000Z",
        "id": "WRUN-6fe9e53c-945a-4aa3-a87e-d64c3cc0dcb0",
        "workflowRunId": "WRUN-6fe9e53c-945a-4aa3-a87e-d64c3cc0dcb0",
        "workflowId": "PKGW-d0f4f3eb-16b9-4973-8e1e-939af867ce56",
        "credits": 22
      },
      {
        "createdAt": "2023-09-27T18:24:46.998Z",
        "id": "WRUN-137a0cd4-7dc3-412d-8d1c-854bddbdc230",
        "workflowRunId": "WRUN-137a0cd4-7dc3-412d-8d1c-854bddbdc230",
        "workflowId": "PKGW-d0f4f3eb-16b9-4973-8e1e-939af867ce56",
        "credits": 0
      }
    ]
  }
}

请求参数

Path 参数
workflow_id
string 
工作流程ID
必需
Query 参数
size
string 
必需
分页中包含的运行数(最多 100,默认为 10)。
示例值:
10
page
string 
必需
用于指定更多页面(从 1 开始)。
示例值:
1
Header 参数
x-copy-ai-api-key
string 
必需
示例值:
key goes here

返回响应

🟢200成功
application/json
Body
status
string 
必需
data
object 
必需
total
integer 
必需
data
array [object {6}] 
必需
🟠404记录不存在
修改于 2023-12-26 09:51:39
上一页
获取工作流运行
Built with