REST API

ワークスペース

PAT所有者がアクセスできるワークスペースと詳細設定を取得します。一覧にはPATが無効なワークスペースも含まれる場合があるため、返されたslugで直ちにワークスペーススコープAPIを呼び出せるとは限りません。

GET/v2/workspaces

Workspace リストの照会

リクエスト元がアクセスできるワークスペースの一覧を取得します。

パラメータ

status
WorkspaceStatus | null
query
取得するワークスペースのステータスです。
only_activeboolean | nullquery
有効なワークスペースのみを取得するかどうかを示します。
offsetintegerqueryデフォルト 0
最初に返却する項目の0始まりのオフセットです。
limitintegerqueryデフォルト 20
返却する項目の最大数です。

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

items必須V2Workspace[]
ワークスペースの一覧です。
id必須integer
ワークスペースの識別子です。
slug必須string
リクエストパスで使用する現在のワークスペーススラッグです。
name必須string
ワークスペース名です。
emailstring | null
ワークスペースの代表メールアドレスです。
billing_email必須string
ワークスペースの請求先メールアドレスです。
keywords必須string[]
ワークスペースのデフォルトキーワード一覧です。
color必須string
ワークスペースの表示色です。
use_2fa必須boolean
二要素認証を使用するかどうかを示します。
ip_block_type必須·
IpBlockType
ワークスペースのIPアクセス制限方式です。
status必須·
WorkspaceStatus
ワークスペースの状態です。
referrer_codestring | null
ワークスペースの紹介コードです。
domains必須string[]
ワークスペースに登録されたメールドメインの一覧です。
pat_enabled必須boolean
パーソナルアクセストークンを使用してワークスペーススコープの API を呼び出せるかどうかを示します。
base_role必須·
BaseWorkspaceRole
リクエスト実行者のワークスペースにおけるデフォルトロールです。
settings必須V2WorkspaceSettings
ワークスペースのレコードと保持に関するデフォルト設定です。
created_at必須string (date-time)
ワークスペースの作成日時です。
updated_at必須string (date-time)
ワークスペースの最終更新日時です。
page必須V2Pagination
ワークスペース一覧のページ情報です。
offset必須integer
最初に返却する項目の0始まりのオフセットです。
limit必須integer
指定された最大項目数です。
total必須integer
条件に一致する項目の総数です。

レスポンス例

{
  "items": [
    {
      "id": 1,
      "slug": "your-workspace",
      "name": "Example",
      "billing_email": "developer@example.com",
      "keywords": [
        "string"
      ],
      "color": "string",
      "use_2fa": true,
      "ip_block_type": "none",
      "status": "created",
      "domains": [
        "string"
      ],
      "pat_enabled": true,
      "base_role": "workspace_manager",
      "settings": {
        "default_access_scope": "all",
        "default_transcribe_language": "detect",
        "save_media": true,
        "save_dialog": true,
        "provision_type": "scim_auto",
        "request_insight_extract_type": "custom"
      },
      "created_at": "2026-08-27T03:00:00Z",
      "updated_at": "2026-08-27T03:00:00Z"
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

エラー

ステータス	エラーコード	説明
401	UNAUTHORIZED	未認証のリクエスト
422	VALIDATION_ERROR	処理できないコンテンツ
429	RATE_LIMIT_EXCEEDED	リクエスト上限超過詳細

GET/v2/workspaces/{slug}/quota

ワークスペースの使用量と制限の照会

ワークスペースの現在の使用量と制限を照会します。

パラメータ

slug必須stringpath
ワークスペーススラッグ

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/quota" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

plan必須ApiSubscriptionPlan
現在適用中のサブスクリプションプランです。
code必須string
サブスクリプションプランのコードです。
plan必須string
人が読めるサブスクリプションプラン名です。
usage_reset_cycle必須·
SubscriptionCycle
含まれる使用量がリセットされる周期です。
price必須ApiSubscriptionPlanPrice
サブスクリプションプランの価格情報です。
included必須ApiSubscriptionPlanIncluded
サブスクリプションプランに含まれるリソース情報です。
features必須SubscriptionPlanFeature[]
サブスクリプションプランで有効な機能一覧です。
purchase_policy必須ApiSubscriptionPlanPurchasePolicy
サブスクリプションプランの購入ポリシーです。
usage_period必須ApiWorkspaceQuotaUsagePeriod
現在の使用量集計期間です。
start_date必須string (date)
使用量集計期間の開始日です。
end_date必須string (date)
使用量集計期間の終了日です。
quota必須ApiWorkspaceQuotaMetrics
現在のプランで利用できる上限です。
seat必須integer
アーカイブ権限を持つメンバー数です。
viewer必須integer | null
閲覧者メンバー数です。制限がない場合はnullです。
recording_seconds必須number
収録時間です。単位は秒です。
usage必須ApiWorkspaceQuotaMetrics
現在の使用量です。
seat必須integer
アーカイブ権限を持つメンバー数です。
viewer必須integer | null
閲覧者メンバー数です。制限がない場合はnullです。
recording_seconds必須number
収録時間です。単位は秒です。
remaining必須ApiWorkspaceQuotaMetrics
現在の残り利用可能量です。
seat必須integer
アーカイブ権限を持つメンバー数です。
viewer必須integer | null
閲覧者メンバー数です。制限がない場合はnullです。
recording_seconds必須number
収録時間です。単位は秒です。
allows_overage必須boolean
収録上限を超えた分を後払いで利用できるかどうかを示します。
rate_limit必須ApiWorkspaceRateLimit
v2 公開 API のリクエスト上限ポリシーです。
scopestring
リクエスト上限を適用する単位です。
limit必須integer
固定ウィンドウ内で許可される最大リクエスト数です。
window_seconds必須integer
リクエスト数を集計する固定ウィンドウの長さ（秒）です。

レスポンス例

{
  "plan": {
    "code": "string",
    "plan": "string",
    "usage_reset_cycle": "monthly",
    "price": {
      "base": 1,
      "seat": 1,
      "recording_minutes": 1
    },
    "included": {
      "seat": 1,
      "viewer": 1,
      "unlimited_viewer": true,
      "recording_minutes": 1,
      "labels": 1,
      "restricted_event_words": 1
    },
    "features": [
      "ai_recording"
    ],
    "purchase_policy": {
      "additional_seat": true
    }
  },
  "usage_period": {
    "start_date": "2026-08-27",
    "end_date": "2026-08-27"
  },
  "quota": {
    "seat": 1,
    "viewer": 1,
    "recording_seconds": 1
  },
  "usage": {
    "seat": 1,
    "viewer": 1,
    "recording_seconds": 1
  },
  "remaining": {
    "seat": 1,
    "viewer": 1,
    "recording_seconds": 1
  },
  "allows_overage": true,
  "rate_limit": {
    "scope": "workspace",
    "limit": 1,
    "window_seconds": 1
  }
}

エラー

ステータス	エラーコード	説明
401	UNAUTHORIZED	未認証のリクエスト
403	FORBIDDEN	リクエスト元の権限が不足しています
404	WORKSPACE_NOT_FOUND	存在しません
422	VALIDATION_ERROR	処理できないコンテンツ
429	RATE_LIMIT_EXCEEDED	リクエスト上限超過詳細

GET/v2/workspaces/{slug}

Workspace 詳細検索

スラッグに対応するワークスペースの詳細情報を取得します。

パラメータ

slug必須stringpath
ワークスペーススラッグ

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

id必須integer
ワークスペースの識別子です。
slug必須string
リクエストパスで使用する現在のワークスペーススラッグです。
name必須string
ワークスペース名です。
emailstring | null
ワークスペースの代表メールアドレスです。
billing_email必須string
ワークスペースの請求先メールアドレスです。
keywords必須string[]
ワークスペースのデフォルトキーワード一覧です。
color必須string
ワークスペースの表示色です。
use_2fa必須boolean
二要素認証を使用するかどうかを示します。
ip_block_type必須·
IpBlockType
ワークスペースのIPアクセス制限方式です。
status必須·
WorkspaceStatus
ワークスペースの状態です。
referrer_codestring | null
ワークスペースの紹介コードです。
domains必須string[]
ワークスペースに登録されたメールドメインの一覧です。
pat_enabled必須boolean
パーソナルアクセストークンを使用してワークスペーススコープの API を呼び出せるかどうかを示します。
base_role必須·
BaseWorkspaceRole
リクエスト実行者のワークスペースにおけるデフォルトロールです。
settings必須V2WorkspaceSettings
ワークスペースのレコードと保持に関するデフォルト設定です。
default_access_scope必須·
DefaultAccessScope
新しいレコードのデフォルトアクセス範囲です。
default_transcribe_language必須·
TranscribeLanguage
新しいレコードのデフォルト文字起こし言語です。
save_media必須boolean
元メディアを保存するかどうかを示します。
save_dialog必須boolean
文字起こしを保存するかどうかを示します。
provision_type必須·
ProvisionType
メンバーのプロビジョニング方式です。
max_device_session_countinteger | null
メンバーごとのデバイスセッション上限数です。
request_insight_extract_type必須·
WorkspaceInsightExtractType
デフォルトのインサイト生成タイプです。
default_custom_insight_template_idinteger | null
デフォルトのカスタムインサイトテンプレート識別子です。
record_lifecycle_daysinteger | null
レコードを保持する日数です。
media_lifecycle_daysinteger | null
元メディアを保持する日数です。
dialog_lifecycle_daysinteger | null
文字起こしを保持する日数です。
created_at必須string (date-time)
ワークスペースの作成日時です。
updated_at必須string (date-time)
ワークスペースの最終更新日時です。

レスポンス例

{
  "id": 1,
  "slug": "your-workspace",
  "name": "Example",
  "billing_email": "developer@example.com",
  "keywords": [
    "string"
  ],
  "color": "string",
  "use_2fa": true,
  "ip_block_type": "none",
  "status": "created",
  "domains": [
    "string"
  ],
  "pat_enabled": true,
  "base_role": "workspace_manager",
  "settings": {
    "default_access_scope": "all",
    "default_transcribe_language": "detect",
    "save_media": true,
    "save_dialog": true,
    "provision_type": "scim_auto",
    "request_insight_extract_type": "custom"
  },
  "created_at": "2026-08-27T03:00:00Z",
  "updated_at": "2026-08-27T03:00:00Z"
}

エラー

ステータス	エラーコード	説明
401	UNAUTHORIZED	未認証のリクエスト
403	FORBIDDEN	リクエスト元の権限が不足しています
404	WORKSPACE_NOT_FOUND	存在しません
422	VALIDATION_ERROR	処理できないコンテンツ
429	RATE_LIMIT_EXCEEDED	リクエスト上限超過詳細