No data

API 接口文档

本文档描述了供外部系统（如 n8n）调用的 API 接口。

鉴权说明

部分接口需要使用 API Key 进行鉴权。请在请求参数中携带 apiKey。

示例：https://api.flowonn.com/usage/events?apiKey=sk_...

注意：/api/credits/deduct 接口通过 Body 传递 api_key，不需要 Query 参数。

GET

/workflow-credits/query

根据工作流 ID 或名称查询对应的积分消耗配置。无需鉴权。

请求地址

https://api.flowonn.com/workflow-credits/query

cURL 示例

curl "https://api.flowonn.com/workflow-credits/query?workflow_id=test_001"

请求参数

参数名	类型	必填	描述
`workflow_id`	string	否	n8n 工作流 ID (优先匹配)
`workflow_name`	string	否	n8n 工作流名称

响应示例

{
  "ok": true,
  "data": {
    "id": "uuid",
    "workflow_id": "test_001",
    "workflow_name": "Test Workflow",
    "credit_cost": 1,
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2023-01-01T00:00:00Z"
  }
}

GET

/workflow-credits/all

获取系统中所有已配置的工作流积分规则。无需鉴权。

请求地址

https://api.flowonn.com/workflow-credits/all

cURL 示例

curl "https://api.flowonn.com/workflow-credits/all"

请求参数

参数名	类型	必填	描述
No data

响应示例

{
  "ok": true,
  "data": {
    "data": [ ... ],
    "total": 10,
    "page": 1,
    "pageSize": 10
  }
}

POST

/api/credits/deduct

上报一次积分消耗事件。通过 Body 中的 api_key 进行鉴权（无需 Query Param）。

请求地址

https://api.flowonn.com/api/credits/deduct

cURL 示例

curl -X POST "https://api.flowonn.com/api/credits/deduct" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "sk_YOUR_API_KEY",
    "amount": 100,
    "workflow_id": "test_wf",
    "workflow_name": "Test Workflow"
  }'

请求参数

参数名	类型	必填	描述
`api_key`	Body (string)	是	API Key (sk_...)
`amount`	Body (int)	是	需要扣除的积分数量
`reason`	Body (string)	否	扣减原因 (默认 api_deduct)
`workflow_id`	Body (string)	否	工作流 ID
`workflow_name`	Body (string)	否	工作流名称

响应示例

{
  "ok": true,
  "data": {
    "balanceAfter": 9800,
    "deducted": 100
  }
}

GET

/usage/events

需鉴权

查询当前 API Key 对应用户的积分消耗记录。支持分页。

请求地址

https://api.flowonn.com/usage/events

cURL 示例

curl "https://api.flowonn.com/usage/events?apiKey=sk_YOUR_API_KEY&page=1&size=20"

请求参数

参数名	类型	必填	描述
`apiKey`	Query Param	是	您的 API Key (例如 sk_...)
`page`	integer	否	页码，默认 1
`size`	integer	否	每页数量，默认 20

响应示例

{
  "ok": true,
  "data": {
    "data": [
      {
        "id": "usage_001",
        "delta": -10,
        "balanceAfter": 9990,
        "reason": "usage",
        "workflowId": "wf_123",
        "workflowName": "My Workflow",
        "createdAt": "2023-11-28T10:00:00Z",
        "apiKeyId": "key_abc"
      }
    ],
    "total": 100,
    "page": 1,
    "pageSize": 20
  }
}

GET

/usage/events/all

需鉴权

获取当前 API Key 对应用户的所有积分消耗记录。

请求地址

https://api.flowonn.com/usage/events/all

cURL 示例

curl "https://api.flowonn.com/usage/events/all?apiKey=sk_YOUR_API_KEY"

请求参数

参数名	类型	必填	描述
`apiKey`	Query Param	是	您的 API Key (例如 sk_...)

响应示例

{
  "ok": true,
  "data": {
    "data": [ ... ],
    "total": 100
  }
}