概要
Postmanコレクション
Postmanは、APIの開発とテストのための強力なツールです。簡単にAPIの作成、管理、テストを行うことができます。GPTBotsでは、APIテストを容易にするためのPostmanコレクションを提供しています。
GPTBots Postmanコレクション
基本的な制約事項
GPTBots API は HTTP および REST の仕様に準拠して設計されています。
クエリリクエストには GET メソッドを使用し、データの送信には POST メソッドを使用します。
適切な HTTP メソッドを使用していないリクエストはエラーとして返されます。
特に指定がない限り、パラメータの値はUTF-8によるURL encodingを適用してください。
認証
GPTBots REST APIではHTTP Basic Authenticationを使用します。以下のAuthorization
ヘッダーを追加してください:
Authorization: Bearer ${apiKey}
APIの有効化
- APIサービスを有効にするには、GPTBotsのダッシュボードにアクセスし、「エージェント連携」→「開発用APIサービス」に進み、「有効化」ボタンをクリックしてください。
- APIサービスを有効化した後、「API」カードをクリックしてAPI管理ページに移動します。「APIキーを作成」ボタンをクリックすると、GPTBots APIを呼び出すためのAPIキーを生成できます。
API ベースURL
API URLの形式:
https://api-${endpoint}.gptbots.ai/
{endpoint}は、組織作成時に選択したデータセンターを表します。開発者は要件に応じて適切な{endpoint}を選択してください。
データセンター一覧
GPTBotsプラットフォームで利用可能なデータセンターは以下の通りです:
データセンター | エンドポイント | APIベースURL |
---|---|---|
シンガポール | sg | https://api-sg.gptbots.ai/ |
タイ | th | https://api-th.gptbots.ai/ |
APIリクエストURLで
-{endpoint}
を指定しない場合、デフォルトのデータセンターはシンガポールとなります。
すべてのAPIリクエストには適切なエンドポイントパスを含める必要があります。例えば、シンガポールのデータセンターを使用する組織の場合、APIリクエストURLは次のようになります:https://api-sg.gptbots.ai/v2/conversation
APIリスト
GPTBotsプラットフォームは、開発者のビジネスニーズに対応するための包括的なAPIインターフェースを提供しています。開発者は要件に応じて適切なAPIを選択できます。APIのカテゴリは以下のとおりです:
カテゴリー | 説明 |
---|---|
Conversation API | エージェントとの対話・会話ができます。 |
Workflow API | ワークフローへリクエストを送信し、レスポンスを受け取ります。 |
Knowledge API | GPTBotsプラットフォーム上のナレッジベースを管理します。 |
Database API | GPTBotsプラットフォーム上のデータベースを管理します。 |
Models API | GPTBotsプラットフォームの各種モデル機能を利用します。 |
User API | ユーザー情報や属性、連絡先の詳細設定が行えます。 |
Analytics API | クレジットとトークンの使用データを照会します。 |
Account API | アカウントに関連するエージェント、組織などの情報を取得します。 |
API使用制限
GPTBotsプラットフォームではAPI呼び出しに対してレート制限を設けており、APIの種類ごとに異なる上限が設定されています。上限を超えるとレート制限超過のエラーメッセージが返されます。具体的な制限は以下のとおりです:
- フリープラン:すべてのAPIタイプはデフォルトで1分あたり3回のリクエストに制限されています。
- エンタープライズ向けカスタムプラン:GPTBotsの営業担当者にご連絡いただくことで、カスタマイズされたレート制限の特典をご利用いただけます。