API リファレンス

接続

接続の設定と、お客様のアカウントでの認可。

HTTP 接続と MCP 接続を保存し、OAuth 接続を認可して、実行が使えるものを一覧します。接続の設定には、管理者キーか、ログイン中のオーナーまたは管理者が必要です。メンバーはカタログを読み取れます。呼び出しが仲介される仕組みについては、接続をご覧ください。

接続を保存

PUT/v1/connections/{name}
接続を作成します。同じ名前がすでにある場合は置き換えます。名前のルールは、ワークフローの名前と同じです。オーナーまたは管理者のみ。
ボディ
typestring必須
http または mcp。
urlstring必須
API の HTTPS ベース URL、または MCP サーバーの Streamable HTTP エンドポイント。パブリックなアドレスに解決される必要があります。
authobject
認証の方法。認証が不要な場合は省略します。
allowed_methodsstring[]
HTTP 接続: 実行が使えるメソッド。["GET"] など。空の場合はすべて許可されます。
allowed_toolsstring[]
MCP 接続: 実行が呼び出せるツール名。空の場合はすべて許可されます。
instructionsstring
エージェントが API を使う方法 (エンドポイント、リクエストの形式、慣例)。エージェントに表示されるため、シークレットは含めないでください。最大 4,000 文字。

auth オブジェクト

typestring
none、bearer、header、basic、oauth2 のいずれか。
tokenstring
bearer と header 用。
headerstring
header 用。ヘッダー名。X-API-Key など。
username, passwordstring
basic 用。ユーザー名にコロンを含めることはできません。
client_idstring
oauth2 用。authorization_url、token_url とともに必須です。
client_secretstring
クライアントシークレットを持つ oauth2 クライアント用。
authorization_url, token_urlstring
プロバイダーの OAuth エンドポイント。HTTPS。
token_auth_methodstring
client_secret_basic、client_secret_post、none のいずれか。
scopesstring[]
要求するスコープ。
resourcestring
認可リクエストと一緒に送る、リソースインジケーター (任意)。
{
  "type": "http",
  "url": "https://api.example.com/v2",
  "auth": { "type": "header", "header": "X-API-Key", "token": "sk_live_…" },
  "allowed_methods": ["GET"],
  "instructions": "Look up a payment with GET /v1/payments/{id}. Amounts are in cents."
}

レスポンスは {"name": "...", "type": "..."} です。Ephemeral は、保存する前に URL と認証情報の形式を検証します。

シークレットを再送せずに接続を更新するには、シークレットのフィールドを省き、同じ auth.type で保存します。保存済みのトークン、パスワード、クライアントシークレット、OAuth トークンは保持されます。auth.type を変更すると、認証は完全に置き換わります。

接続を一覧

GET/v1/connections
オーナーまたは管理者のみ。すべての接続を、name、type、url、allowed_methods、allowed_tools、authenticated、auth のシークレットでない部分とともに返します。

接続を取得

GET/v1/connections/{name}
オーナーまたは管理者のみ。認証情報を除き、URL 内のクエリの値をマスクした設定を返します。

接続を削除

DELETE/v1/connections/{name}
オーナーまたは管理者のみ。204 No Content を返します。
削除された接続を、直接またはワークフロー経由で参照する実行は、作成時に拒否されます。すでに進行中の実行は、次にその接続を呼び出した時点でアクセスできなくなります。

OAuth 接続を認可

POST/v1/connections/{name}/oauth/start
オーナーまたは管理者のみ。プロバイダーの認可ページである {"url": "..."} を返します。

ブラウザーで URL を開き、アクセスを承認します。プロバイダーがエンジンの /oauth/callback にリダイレクトし、Ephemeral がコードを交換してトークンを保存すると、ブラウザーはダッシュボードに戻ります。各 URL は 1 回しか使えません。プロバイダーには、リダイレクト URI として https://app.ephemer.al/oauth/callback を登録してください。セルフホストのインストールでは、独自のドメインを登録します。

認可の進行中に、接続のクライアント ID または OAuth エンドポイントが変更された場合、コールバックは 409 で拒否されます。その場合は、最初からやり直してください。CLI では、ephemeral oauth connect NAME で 1 ステップで実行できます。

接続カタログ

GET/v1/catalog/connections
すべてのロールで利用できます。実行が参照できる接続を、URL と認証設定を除いて一覧します。
JSON
[
  { "name": "docs-mcp", "type": "mcp", "allowed_methods": [], "allowed_tools": ["search", "get_document"], "authenticated": true },
  { "name": "payments-api", "type": "http", "allowed_methods": ["GET"], "allowed_tools": null, "authenticated": true }
]
保存済みの接続へのアクセスは、組織全体で共通です。すべてのメンバーが、すべての保存済み接続を名前で使えます。メンバーごとの権限付与はありません。
© 2026 Ephemeral制作: erni.works
esc

「」に一致する項目はありません。