アカウントで利用可能なボットのリストを取得します。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ロール管理] の [ロール管理] の管理APIスコープを必要とします。
GET https://{{host}}/api/public/bots?offset=0&limit=50s
クエリパラメータ
パラメータ | 必須/任意 | 説明 |
---|---|---|
ホスト | 必須 | 環境URL(例: https://bots.kore.ai) |
offset | 任意 | アカウントに、作成されたボットの取得を開始するページ番号を指定します。指定されていない場合は、ボットのリストの最初のページである0から開始されます。 |
limit | 任意 | 取得するボット数です。最大値は50です。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X GET \ 'https://{{host}}/api/public/bots?offset=0&limit=50' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
サンプル応答
{ "total": 69, "availableMore": true, "bots": [ { "_id": "st-eb254250-d9ea-5dfb-a369-7e104a115e51", "purpose": "customer", "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91", "defaultLanguage": "en", "accountId": "5c04ae921ad9976d311e9b4b", "type": "default", "resourceid": "btstreams", "status": "configured", "name": "GitHub Sample_1543832655266", "description": 「プラットフォームのいくつかの基本的な機能に慣れるために、Github APIを使用して作成されたボットです。IDPの情報を提供し、Gitリポジトリを使用してボットを試行します。構成について探り、アラートタスク、アクションタスク、ナレッジタスクの詳細を知りましょう。」}, { "_id": "st-656dffde-34e7-58c6-885b-25a38112739d", "purpose": "employee", "createdBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91", "defaultLanguage": "en", "accountId": "5c04ae921ad9976d311e9b4b", "type": "default", "resourceid": "btstreams", "status": "configured", "name": "Travel Planning Sample_1543832655269", "description": 「このサンプルボットは、プラットフォームが提供する5つのタスクタイプを保持しています。このボットは、オープンAPIを使用して構築されており、フライト情報、位置情報、天気の詳細を取得します。あなたのインテントにより適切に応答するために、自然言語のボットを探り、トレーニングします。」} ] }