CallaboDevelopersBeta
ドキュメントメニュー

REST API

ラベル

ワークスペースのラベル、複数レコードのラベル状態、推奨ラベルを取得します。

GET/v2/workspaces/{slug}/labels

Label リストの照会

ワークスペースのラベルとラベルごとのレコード数を取得します。

パラメータ

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

リクエスト例

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

成功レスポンス

レスポンス本文

  • items必須V2LabelWithRecordCount[]
    この値に含まれる項目一覧です。
  • id必須integer
    ラベルの識別子です。
  • name必須string
    ラベル名です。
  • color必須string
    ラベルの表示色です。
  • record_count必須integer
    レコード数です。

レスポンス例

{
  "items": [
    {
      "id": 1,
      "name": "Example",
      "color": "string",
      "record_count": 1
    }
  ]
}

エラー

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

複数のレコードのラベルステータスの検索

指定した複数レコードのラベル適用状態を取得します。

パラメータ

  • slug必須stringpath
    ワークスペーススラッグ
  • record_ids必須integer[]query
    ラベル状態を取得するレコードIDの一覧です。

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/records/labels/status?record_ids=1" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

  • labels必須V2BulkLabelStatusItem[]
    リソースに関連付けられたラベル一覧です。
  • id必須integer
    ラベルの識別子です。
  • name必須string
    ラベル名です。
  • color必須string
    ラベルの表示色です。
  • status必須V2BulkLabelStatus
    現在のステータスです。

レスポンス例

{
  "labels": [
    {
      "id": 1,
      "name": "Example",
      "color": "string",
      "status": "unchecked"
    }
  ]
}

エラー

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

複数レコードにラベルを関連付け

指定した複数のレコードにラベルを関連付けます。

パラメータ

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

リクエスト本文

関連付けるレコードとラベルの一覧です。

  • record_ids必須integer[]
    ラベルの関連付けを変更するレコード識別子の一覧です。
  • label_ids必須integer[]
    関連付けまたは関連付け解除するラベル識別子の一覧です。

リクエスト例

curl --request POST \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/records/labels" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT" \
  --header "Content-Type: application/json" \
  --data '{
  "record_ids": [
    1
  ],
  "label_ids": [
    1
  ]
}'

成功レスポンス

エラー

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

複数レコードのラベル関連付けを解除

指定した複数のレコードからラベルの関連付けを解除します。

パラメータ

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

リクエスト本文

関連付けを解除するレコードとラベルの一覧です。

  • record_ids必須integer[]
    ラベルの関連付けを変更するレコード識別子の一覧です。
  • label_ids必須integer[]
    関連付けまたは関連付け解除するラベル識別子の一覧です。

リクエスト例

curl --request DELETE \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/records/labels" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT" \
  --header "Content-Type: application/json" \
  --data '{
  "record_ids": [
    1
  ],
  "label_ids": [
    1
  ]
}'

成功レスポンス

エラー

ステータスエラーコード説明
400INVALID_LABEL_SELECTION無効なリクエスト
401UNAUTHORIZED未認証のリクエスト
403FORBIDDENリクエスト元の権限が不足しています
404WORKSPACE_NOT_FOUND存在しません
422VALIDATION_ERROR処理できないコンテンツ
429RATE_LIMIT_EXCEEDEDリクエスト上限超過詳細
GET/v2/workspaces/{slug}/records/{record_id}/label-recommendations

レコードラベル推薦一覧取得

レコードに対して生成されたラベル推薦の一覧を取得します。

パラメータ

  • record_id必須integerpath
    レコードの識別子です。
  • slug必須stringpath
    ワークスペーススラッグ

リクエスト例

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

成功レスポンス

レスポンス本文

  • record_id必須integer
    レコードの識別子です。
  • recommendations必須V2RecommendedLabel[]
    レコードに推薦されたラベル一覧です。
  • label_id必須integer
    推奨ラベルの識別子です。
  • label_name必須string
    推奨ラベル名です。

レスポンス例

{
  "record_id": 1,
  "recommendations": [
    {
      "label_id": 1,
      "label_name": "string"
    }
  ]
}

エラー

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