跳转到内容

API 密钥

个人访问令牌(PAT)让你能够从外部工具和代码中,向 Pipe2.ai API 和 MCP 服务器进行身份认证。

创建令牌

  1. 前往 pipe2.ai/api-keys
  2. 点击创建令牌 配合 MCP 客户端:
  3. 复制该令牌 —— 它只会显示一次

使用你的令牌

配合 SDK:

import { createClient } from '@pipe2-ai/sdk';
const client = createClient('YOUR_TOKEN');

配合 MCP 客户端:

{
"headers": {
"Authorization": "Bearer YOUR_TOKEN"
}
}

配合原始 GraphQL:

Terminal window
curl -X POST https://api.pipe2.ai/v1/graphql \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"query": "{ pipelines { name } }"}'

吊销令牌

点击任意令牌旁的吊销按钮。吊销将在 30 秒内生效。该令牌将对所有正在使用它的客户端停止工作。

密钥设置

每个账户最多可保留25个有效密钥。已吊销或过期的密钥会腾出名额。创建密钥时,你可以设置名称、可选的多条允许运行的流水线、积分上限、重置周期(不重置、每天、每周、每月或每年)及有效期(1、7、30、90或365天)。周期按UTC日历计算,周一为每周起点。未设置上限时,密钥可使用账户中的可用积分。

使用 pipelines:run 可运行任意流水线;若只允许指定流水线,请为每个流水线添加一个 pipeline:run:SLUG 权限。一个密钥可以包含多个此类权限。API 和 MCP 请求仅使用所选权限。权限和列表在创建后无法更改;如需调整,请撤销密钥并创建新密钥。请将外部应用使用的密钥存放在服务器上。

若运行的预留额度超出密钥的剩余额度,运行会被阻止。实际扣费在结算后显示,退款会释放预留额度。

mutation {
create_personal_access_token(
name: "My application"
scopes: ["pipeline:run:YOUR_PIPELINE_SLUG", "pipeline:run:ANOTHER_PIPELINE_SLUG"]
credit_limit: 100
reset_period: "daily"
expires_in_days: 90
) { token expires_at }
}