AIアシスタントビルダー用のAPIキーの生成

AIアシスタントビルダーAPI のメソッドを利用するには、APIキーを生成する必要があります。

watsonx Orchestrate」でAIアシスタントビルダーのAPIキーを生成するには、以下の手順を実行します：

  1. AI assistant builderをwatsonx Orchestrateで開く。
  2. AIアシスタントを選択する。
  3. アシスタント設定をクリックします。
  4. アシスタントのIDとAPIの詳細で 、「APIキーを生成」 をクリックして、 URLの APIキーを生成します。

API キーを使用して API に対する要求を認証するには、ユーザー名に apikey を使用し、パスワードに API キーの値を使用します。 例えば、API キーが f128743asfdSF8bvの場合、 curl ツールを使用した API 呼び出しの構文は次のようになります。

curl -X {request_method} -u "apikey:f128743asfdSF8bv" "{endpointUrl}/v2/{method}

ここで:

  • {request_method}

    要求用の HTTP メソッド。

  • {endpointUrl}

    サービスインスタンスURL。 これにはパスの/instances/{instance_id}の部分を含める必要がある。 例えば、次のとおりです。https://api.us-south.assistant.watson.cloud.ibm.com/instances/{instance_id}

AIアシスタントビルダーのURL を watsonx Orchestrate で表示するには、以下の手順に従います

  1. AI assistant builderをwatsonx Orchestrateで開く。
  2. アシスタントを選択します。
  3. アシスタント設定をクリックします。
  4. アシスタントのIDとAPIの詳細で 、「詳細を表示」 をクリックすると、サービスURL が表示されます。

  • {method}

    実行したいAIアシスタントビルダーAPIのメソッド。 詳細はAI アシスタントビルダーAPIを参照してください。 AIアシスタントビルダーと[対象 IBM watsonx Assistant ]の方法は同じです。

重要: watsonx OrchestrateAPI の API キーには有効期限があります。 APIキーの有効期限は、発行日から1年間です。

親トピック:

→ AIアシスタントビルダーAPIの概要