APIエンドポイントの取得

watsonx Orchestrate APIエンドポイントは、使用するサービスによって異なる。

正しいエンドポイントを見つけるには、特定のオファーの指示に従ってください。


IBM Cloud 献金

IBM Cloud オファリングの API エンドポイントを取得する:

  1. ログイン watsonx Orchestrate アカウントにログイン

  2. プロフィールアイコン > 設定をクリックします。

    ユーザーアイコンと設定オプション
    図1: プロフィールアイコンと設定オプション

  3. APIの詳細タブを選択する。

  4. サービスURL をコピーします。

エンドポイントのフォーマットは以下の通り:

https://<hostname>/instances/<tenant_id>

ここで:

  • <hostname>watsonx Orchestrate ベース URL。 一般的なフォーマットは以下の通り:
    • https://api.<ibm-cloud-region>.watson.cloud.ibm.com/
    • https://api.<ibm-cloud-region>.cloud.ibm.com/
  • <tenant_id> はあなたの watsonx Orchestrate テナントIDです。

AWSAmazon Web Services が提供するサービス

AWS オファリングの API エンドポイントを取得する:

  1. ログイン watsonx Orchestrate アカウントにログイン

  2. プロフィールアイコン > 設定をクリックします。

    ユーザーアイコンと設定オプション
    図1: プロフィールアイコンと設定オプション

  3. APIの詳細タブを選択する。

  4. サービスURL をコピーします。

エンドポイントのフォーマットは以下の通り:

https://api.<region_code>.watson-orchestrate.ibm.com/instances/<tenant_id>

ここで:

  • <region_code> はインスタンスがホストされている AWS リージョンです。
  • <tenant_id> はあなたの watsonx Orchestrate テナントIDです。

オンプレミス型サービス

オンプレミスの場合、エンドポイントは使用したいAPIに依存する:

  • watsonx Orchestrate API
  • AIアシスタント・ビルダーAPI

AIアシスタントビルダーAPIエンドポイント:

https://{onprem_host}:{port}/assistant/{namespace}/instances/{instance_id}/api

watsonx Orchestrate API エンドポイント:

https://{onprem_host}:{port}/orchestrate/{namespace}/instances/{instanceid}/v1

パラメーター:

  • {onprem_host}: IBM Software Hub クラスタのホスト名または IP (例: api.example.com)。
    IBM Software Hub ウェブクライアントのインスタンス詳細で見つけてください。
  • {port}:必要な場合はポート番号(例: cpd.example.com:31843 )。
  • {namespace}:インスタンスがデプロイされる名前空間。 サービスインスタンスの詳細を取得APIを使用して取得します。
  • {instanceid}:インスタンスの一意な識別子。 watsonx Orchestrate の場合は、インスタンス詳細 URL の orchestrate- の後の数字である。