API 参考 / blueprints

读取组织配额余额与下次生成预览

GET /api/v1/orgs/{orgId}/quota · getOrgQuota

返回当前组织的配额余额(剩余次数)+ 下次生成消耗预览(具体定价由后台配置,不硬编码)。 仅 active Org Admin 可读;普通成员 404(零感知)。PAT 不可调用本端点。

用于「配额确认 Dialog」(设计稿 2h)的余额展示:草稿全程免费;重试需重新弹此确认门; 失败自动返还(与生成任务的 reserved → settled/released 状态机配合)。

本接口要求浏览器会话。Bearer API Token 无法调用——Token 的生命周期管理必须在网页端完成。

参数

orgId(必填)
string

响应字段 · 200

orgId(必填)
string
balance(必填)
integer
reserved
integer
nextCost
integer
insufficient
boolean

错误

请求示例(curl)

curl -X GET "https://workflow.games/api/v1/orgs/{orgId}/quota" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "orgId": "018f3c2e-0000-7000-8000-000000000000",
  "balance": 1,
  "reserved": 1
}

合同真值:OpenAPI 3.1(0.1.0)。

相关:Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…