はじめに
クイックスタート
PATの発行から最近のミーティングの発話とインサイト取得までを実行します。
準備
- Callaboアカウント
- PATの使用が許可されたワークスペース
- cURLを実行できるターミナル
PATを発行する
Callabo REST APIは個人用PATをBearerトークンとして受け取ります。
PAT設定を開くAuthorizationヘッダー
すべてのリクエストに次のヘッダーを追加します。
Authorization: Bearer <PAT>手順
- 1
PATを発行します
個人設定で用途が分かる名前と有効期限を設定し、トークンをコピーします。
- 2
環境変数に保存します
CALLABO_PATに保存し、ソースコードやシェル履歴に残さないでください。 - 3
ワークスペースのslugを確認します
以下のリクエストでアクセス可能なワークスペースを取得します。一覧にはPATが無効なワークスペースも含まれる場合があります。
- 4
最近のミーティングを確認します
レコード一覧の先頭項目から
idを確認します。 - 5
発話とインサイトを含めます
レコード詳細に
include=dialogs,insightsを追加します。
ワークスペース一覧リクエスト
curl --request GET \
--url "https://api.callabo.ai/v2/workspaces?status=created&limit=20" \
--header "Accept: application/json" \
--header "Authorization: Bearer $CALLABO_PAT"最近のミーティングを確認します
curl --request GET \
--url "https://api.callabo.ai/v2/workspaces/your-workspace/records?order=rec_date&limit=20" \
--header "Accept: application/json" \
--header "Authorization: Bearer $CALLABO_PAT"次のリクエスト
返されたslugとレコードのidを使用して/v2/workspaces/{slug}/records/{record_id}?include=dialogs,insightsを呼び出します。一覧のslugだけでは、そのPATでワークスペーススコープAPIを呼び出せるか判断できません。
問題が発生した場合
- 401:PATの未設定、期限切れ、入力ミスを確認します。対象ワークスペースでPATが無効かどうかも確認します。
- 403:認証後、現在のロールに対象リソースの権限があるか確認します。
- 404:
slug、record_id、現在のユーザーのアクセス範囲を確認します。
安全に使用する
- Gitリポジトリ、ログ、チャット、ドキュメントにトークンを直接入力しないでください。
- 環境変数または組織で承認されたシークレット管理を使用します。
- 漏えいが疑われる場合は、PATを直ちに無効化して再発行します。