自動実行のトリガーに［APIで実行する］を設定すると、APIリクエストを受信したときに、エージェントを自動で実行できます。
自動実行を作成してAPIキーを発行し、連携元からメッセージを送信します。
エージェントに送信するメッセージは、自動実行の設定画面ではなく、APIリクエスト側で指定します。
利用できるプラン
- Bizプラン
- Enterpriseプラン
- 無料トライアル
自動実行を作成してAPIキーを発行する
- 左サイドメニューの［自動実行］にアクセスして、［＋］（新規自動実行）をクリックします。
- 自動実行したいエージェントを選択します。
- トリガーで「APIで実行する」を選択します。
- ［自動実行作成］をクリックして設定を保存します。
- 「APIキー作成」画面で、エージェント名を確認し、「APIキー名」を入力します。
- 有効期限を設定する場合は、［有効期限を設定する］をオンにして日付を指定します。日付を指定しない場合、有効期限はありません。
- ［APIキーを発行］をクリックします。
- 表示されたAPIキーをコピーし、連携システムにて設定します。
APIキーは安全な場所への保存をお願いします。
- ［OK］をクリックして画面を閉じます。
APIキー発行時の注意事項
- 発行完了画面を閉じると、APIキーの全文を再表示できません。
必ず安全な場所に保存してから［OK］をクリックしてください。
- APIキーは、自動実行1件につき3つまで発行できます。
APIリクエストでエージェントを実行する
発行したAPIキーを利用して、以下のエンドポイントURLにAPIリクエストを送信すると、対象のエージェントが実行されます。
接続先とリクエスト形式
| 項目 | 設定内容 |
|---|---|
| エンドポイントURL | https://{お客様のナレフルチャットドメイン}/api/public/v1/autorun例： https://chat.knowleful.jp/api/public/v1/autorun |
| HTTPメソッド | POST |
| Authorizationヘッダー | Bearer {APIキー} |
| Content-Type | application/json |
| リクエスト本文 | {"content":"エージェントに送信するメッセージ"} |
{お客様のナレフルチャットドメイン}は、ご利用のナレフルチャットのドメインに置き換えてください。
{APIキー}は、発行したAPIキーに置き換えてください。
contentの値には、エージェントへ送信するメッセージを指定してください。
送信できる内容と上限
| 項目 | 設定内容 |
|---|---|
| メッセージ | プレーンテキスト |
| 文字数 | 25万文字まで |
APIキー名・有効期限を変更する
- 対象のAPIキーの編集アイコンをクリックします。
- APIキー名や有効期限を変更します。
- ［設定を保存］をクリックします。
※APIキー自体は変更できません。
APIキーを削除する
- 対象のAPIキーの削除アイコンをクリックします。
- 確認画面で、削除するAPIキー名を入力します。
- ［APIキーを削除］をクリックします。
※削除したAPIキーは、その時点から使用できなくなります。この操作は取り消せません。
実行回数の制限と注意事項
実行回数の制限
連続実行を防ぐため、自動実行ごとに次の制限があります。
| 対象期間 | 制限 |
|---|---|
| 5分間 | 10回。制限に達した場合、最後のAPIリクエストから5分間は使用できません。 |
| 1時間 | 30回。毎時00分にリセットされます。 |
| 1日 | 100回。毎日0時にリセットされます。 |
制限を超えた場合は、利用者フィードバックにアラートが通知されます。
また、設定したユーザに、メール通知設定にかかわらずメールが送信されます。
その他の注意事項
- ［APIで実行する］を設定した自動実行では、自動実行一覧からの手動実行は利用できません。
- 個人または企業全体のクレジット制限中は、エージェントを実行しません。
- 利用機能の制限によって、［APIで実行する］を選択できない場合があります。