check-org-details

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Check Organization Details

查看组织详情

PREREQUISITE: Run
+setup-api-key
first to ensure the API key is configured.

Query the Runway API to retrieve the user's organization details — credit balance, usage tier, rate limits, current daily generation counts, and historical credit usage.

前提条件： 请先运行
+setup-api-key
确保API密钥已配置。

调用Runway API获取用户的组织详情——额度余额、使用等级、速率限制、当前每日生成次数以及历史额度使用情况。

Step 1: Verify API Key Is Available

步骤1：确认API密钥可用

Before making any requests, confirm the API key is accessible:

Check for a
```
.env
```
file containing
```
RUNWAYML_API_SECRET
```
Or check if the environment variable is set:
```
echo $RUNWAYML_API_SECRET
```

If the key is not found, tell the user to run

+setup-api-key

first and stop.

发起任何请求前，请先确认API密钥可访问：

检查是否存在包含
```
RUNWAYML_API_SECRET
```
的
```
.env
```
文件
或检查环境变量是否已设置：
```
echo $RUNWAYML_API_SECRET
```

如果未找到密钥，请告知用户先运行

+setup-api-key

并终止后续流程。

Step 2: Query Organization Info

步骤2：查询组织信息

Call

GET /v1/organization

to retrieve the org's tier, credit balance, and current usage.

调用

GET /v1/organization

获取组织的等级、额度余额和当前使用情况。

Node.js

javascript

import RunwayML from '@runwayml/sdk';

const client = new RunwayML();
const details = await client.organization.retrieve();
console.log(JSON.stringify(details, null, 2));

javascript

import RunwayML from '@runwayml/sdk';

const client = new RunwayML();
const details = await client.organization.retrieve();
console.log(JSON.stringify(details, null, 2));

Python

python

from runwayml import RunwayML

client = RunwayML()
details = client.organization.retrieve()
print(details)

python

from runwayml import RunwayML

client = RunwayML()
details = client.organization.retrieve()
print(details)

cURL / fetch (no SDK)

cURL / fetch（不使用SDK）

bash

curl -s https://api.dev.runwayml.com/v1/organization \
  -H "Authorization: Bearer $RUNWAYML_API_SECRET" \
  -H "X-Runway-Version: 2024-11-06" | python3 -m json.tool

bash

curl -s https://api.dev.runwayml.com/v1/organization \
  -H "Authorization: Bearer $RUNWAYML_API_SECRET" \
  -H "X-Runway-Version: 2024-11-06" | python3 -m json.tool

Response Shape

响应结构

json

{
  "tier": {
    "maxMonthlyCreditSpend": 10000,
    "models": {
      "gen4.5": {
        "maxConcurrentGenerations": 2,
        "maxDailyGenerations": 200
      }
    }
  },
  "creditBalance": 5000,
  "usage": {
    "models": {
      "gen4.5": {
        "dailyGenerations": 12
      }
    }
  }
}

json

{
  "tier": {
    "maxMonthlyCreditSpend": 10000,
    "models": {
      "gen4.5": {
        "maxConcurrentGenerations": 2,
        "maxDailyGenerations": 200
      }
    }
  },
  "creditBalance": 5000,
  "usage": {
    "models": {
      "gen4.5": {
        "dailyGenerations": 12
      }
    }
  }
}

Step 3: Present the Results

步骤3：展示结果

Format the output as a clear summary for the user:

undefined

将输出格式化为清晰的摘要展示给用户：

undefined

Organization Overview

组织概览

Credit Balance: X credits ($X.XX at $0.01/credit) Monthly Spend Cap: X credits

额度余额： X点数（按$0.01/点数换算为$X.XX） 月度消费上限： X点数

Rate Limits (by model)

速率限制（按模型划分）

Model	Concurrency	Daily Limit	Used Today	Remaining
gen4.5	2	200	12	188
veo3.1	2	100	5	95
...	...	...	...	...


Key things to highlight:
- **Credit balance** — convert to dollar value (`credits × $0.01`)
- **Per-model daily limits** — show how many generations remain today (rolling 24-hour window)
- **Concurrency** — how many tasks can run simultaneously per model
- **Monthly cap** — the max credit spend per month for their tier

模型	并发数	每日上限	今日已使用	剩余额度
gen4.5	2	200	12	188
veo3.1	2	100	5	95
...	...	...	...	...


需要重点突出的内容：
- **额度余额** —— 换算为美元价值（`点数 × $0.01`）
- **各模型每日上限** —— 展示当日剩余可生成次数（滚动24小时窗口）
- **并发数** —— 每个模型可同时运行的任务数量
- **月度上限** —— 对应等级的每月最高额度消费限制

Step 4 (Optional): Query Credit Usage History

步骤4（可选）：查询额度使用历史

If the user wants to see historical usage, call

POST /v1/organization/usage

如果用户需要查看历史使用情况，调用

POST /v1/organization/usage

。

Node.js

javascript

const usage = await client.organization.retrieveUsage({
  startDate: '2026-02-15',   // ISO-8601, up to 90 days back
  beforeDate: '2026-03-17'   // exclusive end date
});
console.log(JSON.stringify(usage, null, 2));

javascript

const usage = await client.organization.retrieveUsage({
  startDate: '2026-02-15',   // ISO-8601格式，最多可查询90天内数据
  beforeDate: '2026-03-17'   // 结束日期，不含该日期
});
console.log(JSON.stringify(usage, null, 2));

Python

python

usage = client.organization.retrieve_usage(
    start_date="2026-02-15",
    before_date="2026-03-17"
)
print(usage)

python

usage = client.organization.retrieve_usage(
    start_date="2026-02-15",
    before_date="2026-03-17"
)
print(usage)

cURL / fetch (no SDK)

cURL / fetch（不使用SDK）

bash

curl -s -X POST https://api.dev.runwayml.com/v1/organization/usage \
  -H "Authorization: Bearer $RUNWAYML_API_SECRET" \
  -H "X-Runway-Version: 2024-11-06" \
  -H "Content-Type: application/json" \
  -d '{"startDate": "2026-02-15", "beforeDate": "2026-03-17"}' \
  | python3 -m json.tool

bash

curl -s -X POST https://api.dev.runwayml.com/v1/organization/usage \
  -H "Authorization: Bearer $RUNWAYML_API_SECRET" \
  -H "X-Runway-Version: 2024-11-06" \
  -H "Content-Type: application/json" \
  -d '{"startDate": "2026-02-15", "beforeDate": "2026-03-17"}' \
  | python3 -m json.tool

Response Shape

响应结构

json

{
  "results": [
    {
      "date": "2026-03-16",
      "usedCredits": [
        { "model": "gen4.5", "amount": 120 },
        { "model": "veo3.1", "amount": 400 }
      ]
    }
  ],
  "models": ["gen4.5", "veo3.1"]
}

Present this as a usage breakdown:

undefined

json

{
  "results": [
    {
      "date": "2026-03-16",
      "usedCredits": [
        { "model": "gen4.5", "amount": 120 },
        { "model": "veo3.1", "amount": 400 }
      ]
    }
  ],
  "models": ["gen4.5", "veo3.1"]
}

将其展示为使用明细：

undefined

Credit Usage (Feb 15 – Mar 17)

额度使用情况（2月15日 - 3月17日）

Date	Model	Credits Used
2026-03-16	gen4.5	120
2026-03-16	veo3.1	400
...	...	...

Total: X credits

undefined

日期	模型	已使用点数
2026-03-16	gen4.5	120
2026-03-16	veo3.1	400
...	...	...

总计： X点数

undefined

Tier Reference

等级参考

If the user asks about upgrading, share the tier breakdown:

Tier	Concurrency	Daily Gens	Monthly Cap	Unlock Requirement
1 (default)	1–2	50–200	$100	—
2	3	500–1,000	$500	1 day + $50 spent
3	5	1,000–2,000	$2,000	7 days + $100 spent
4	10	5,000–10,000	$20,000	14 days + $1,000 spent
5	20	25,000–30,000	$100,000	7 days + $5,000 spent

Tiers upgrade automatically once the spend and time requirements are met.

如果用户咨询升级问题，请分享等级明细：

等级	并发数	每日生成量	月度上限	解锁要求
1（默认）	1–2	50–200	$100	—
2	3	500–1,000	$500	注册满1天 + 消费满$50
3	5	1,000–2,000	$2,000	注册满7天 + 消费满$100
4	10	5,000–10,000	$20,000	注册满14天 + 消费满$1,000
5	20	25,000–30,000	$100,000	注册满7天 + 消费满$5,000

满足消费和时长要求后，等级将自动升级。

Troubleshooting

故障排查

Issue	Cause	Fix
`401 Unauthorized`	Invalid or missing API key	Re-run `+setup-api-key`
`creditBalance` is 0	No credits purchased	Purchase at https://dev.runwayml.com/ → Billing (min $10)
Daily limit reached	Rolling 24-hour quota exhausted	Wait for the window to reset, or upgrade tier
All models show 0 daily limit	Tier 1 restrictions	Check that credits have been purchased

问题	原因	解决方案
`401 Unauthorized`	API密钥无效或缺失	重新运行 `+setup-api-key`
`creditBalance` 为0	未购买点数	访问https://dev.runwayml.com/ → 账单页面购买（最低$10）
达到每日上限	滚动24小时配额已用完	等待窗口重置，或升级等级
所有模型的每日上限均显示为0	等级1限制	确认已购买点数