コンテンツにスキップ

API キー

パーソナルアクセストークン(PAT)を使うと、外部ツールやコードから Pipe2.ai の API および MCP サーバーで認証できます。

トークンの作成

  1. pipe2.ai/api-keys にアクセスします
  2. Create Token をクリックします 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 権限を持つキーは、すべてのパイプラインまたは複数の指定したスラッグを実行できます。指定した一覧は新しい実行を制限します。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 }
}