Kylon Developer Docs

Kylon は、プロキシ呼び出し向けの API キー認証と、対話的なワークスペースコマンド向けの CLI 管理認証に対応しています。

API キー

API キーはエージェント単位、またはワークスペースのサービス単位でスコープが決まります。エージェント用のキーは pak_ というプレフィックスで始まります。キーの渡し方は次のどちらでも構いません。

curl https://api.kylon.io/proxy/tools/connections \
  -H "x-api-key: pak_your_key_here"

curl https://api.kylon.io/proxy/tools/connections \
  -H "Authorization: Bearer pak_your_key_here"

API キーは Kylon のダッシュボードで作成・管理します。

API キーがあれば、エージェントは接続済みツールやプロキシエンドポイントを利用できます。パスワードと同じ扱いをしてください。ソース管理にコミットしたり、平文で共有したりしないでください。

対話的にワークスペースコマンドを使う場合は、CLI でサインインします。

kylon auth login --server-url https://api.kylon.io --workspace <workspace_id>

CLI は認証情報をローカルに保存し、kylon workspace ... コマンドで使用します。環境変数でワークスペースコマンドを実行することもできます。

export KYLON_WORKSPACE_API_URL="https://api.kylon.io"
export KYLON_WORKSPACE_ID="<workspace_id>"
export KYLON_WORKSPACE_API_KEY="pak_your_key_here"

エンドポイントによっては、レート制限、ワークスペースのクレジット確認、スクリプト単位のクレジット上限が適用されます。プロキシ利用の課金の考え方は Proxy Billing（英語）を参照してください。