APIの使用

Cognigy APIとは?

Cognigy.AIインストールとの通信に、フロントエンドはHTTPベースのAPIを使用します。このAPIは開発者がCognigy.AIとのカスタム統合を構築するために使用することもできます。また、”rest-api-client “と呼ばれるNPMパッケージのライブラリも提供しており、APIを利用する際の負担を軽減することができます。このライブラリはNPMで利用可能で、Typescript定義を含む最新のJavaScriptで記述されています。

APIの機能とは？

フロントエンドに表示されるあらゆる種類の情報と、フロントエンドで実行可能なあらゆる種類のアクションは、このAPIを通じて照会またはトリガーされ、開発者にも100％開示されます。

APIにアクセスするために必要なものは？

APIを使用するには、次の2つのものが必要です：

APIbaseurl

APIが利用できるURLです。

APIキーの管理

APIキーは、ユーザーの認証情報を公開することなく、システム内のユーザーとしてCognigy.AI APIを認証するために使用されます。

APIキーを作成するには、「Create API Keys」をご覧ください。

APIキーを削除するには、「Revoke API Keys」をご覧ください。

APIの使用方法は？

Cognigy APIにはOpenAPIドキュメントがあり、すべての異なるAPI操作の詳細が説明されています。例えばCognigyのトライアル環境については、https://api-trial.cognigy.ai/openapi でご覧いただけます。

APIを呼び出すには、HTTPリクエストを実行し、以下のいずれかを追加します。 – APIキーを値として設定したクエリパラメータapi_key – APIキーを値として設定したヘッダX-API-Key

https://api-dummy.cognigy.ai で Cognigy.AI をインストールし、myDummyApiKey123 という API キーを作成したとします。

新しいブラウザタブを開き、https://api-dummy.cognigy.ai/projects?api_key=myDummyApiKey123 にアクセスすると、プロジェクト内のリソースに関するメタ情報を含め、自分に割り当てられているすべてのプロジェクトのリストを取得できます。この呼び出しは、例えば、Projectsページをロードするときにフロントエンドで使われます。

スーパーAPIキー

Cognigy.AIのほとんどのAPIはエージェント依存です。つまり、APIを使用する開発者は、実際にアクセスできるエージェントからのみ情報を要求することができます。例えば、ある組織内の全ての Flows をリストアップするような用途があります。そのような用途のために、4.1.4リリースで “Super API-Key “と呼ばれる機能を導入しました。

この機能は、デフォルトではすべてのCognigy.AIインストールで無効になっています。オンプレミスのお客様は、以下の環境変数を “true “に設定することでこの機能を有効にすることができます：

FEATURE_USE_SUPERAPIKEY_API

https://api-trial.cognigy.ai/openapi#post-/management/v2.0/organisations/{organisationId}/apikeys

このAPI-keyは特定のユーザーには依存せず、組織の範囲内に存在します。このAPI-keyはシステム内のすべてのアセットとオブジェクトを操作するために使用できます。