メインコンテンツへスキップ

​
エンティティ一覧取得

ナレッジグラフのエンティティ（ノード）をPageRank順で返します。カテゴリ、種別、コミュニティIDでのフィルタリング、ラベル・説明文のキーワード検索に対応しています。

​
リクエスト

GET /api/v1/graph/entities

​
ヘッダー

ヘッダー必須説明
AuthorizationはいBearer snorbe_... 形式の API キー

​
クエリパラメータ

パラメータ型必須デフォルト説明
categorystringいいえ-カテゴリで完全一致フィルタ
kindstringいいえ-種別で完全一致フィルタ
communityIdintegerいいえ-コミュニティIDでフィルタ
searchstringいいえ-ラベル・説明文のキーワード検索
metadataKeywordstringいいえ-メタデータ内キーワード検索
includeOthersEntitiesbooleanいいえfalse他のメンバーのエンティティを含める
limitintegerいいえ301ページあたりの取得件数（1〜100）
cursorstringいいえ-前ページの nextCursor

​
レスポンス

{
  "entities": [
    {
      "id": "clxxx001",
      "label": "リチウムイオン電池",
      "category": "Technology",
      "kind": "battery",
      "description": "充電可能な二次電池の一種",
      "metadata": { "url": { "value": "https://...", "type": "text" } },
      "pagerank": 0.045,
      "communityId": 3,
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-03-20T14:22:00.000Z"
    }
  ],
  "nextCursor": "clxxx031",
  "totalCount": 1296
}

​
レスポンスフィールド

フィールド型説明
entitiesobject[]エンティティ配列（PageRank降順）
entities[].idstringエンティティ ID
entities[].labelstringエンティティ名
entities[].categorystringカテゴリ
entities[].kindstring種別
entities[].descriptionstring説明文
entities[].metadataobject | nullメタデータ（キー・バリュー）
entities[].pageranknumberPageRank スコア
entities[].communityIdnumberコミュニティクラスタ ID
nextCursorstring | null次ページ用カーソル（null = 最終ページ）
totalCountnumberフィルタ後の全件数

​
使用例

# 全エンティティ（PageRank順）
curl "https://app.snorbe.deskrex.ai/api/v1/graph/entities?limit=30" \
  -H "Authorization: Bearer snorbe_your_api_key_here"

# カテゴリでフィルタ
curl "https://app.snorbe.deskrex.ai/api/v1/graph/entities?category=Technology&limit=30" \
  -H "Authorization: Bearer snorbe_your_api_key_here"

# キーワード検索
curl "https://app.snorbe.deskrex.ai/api/v1/graph/entities?search=battery&limit=10" \
  -H "Authorization: Bearer snorbe_your_api_key_here"

​
エラーレスポンス

HTTP ステータスコード説明
401UNAUTHORIZEDAPI キーが無効、期限切れ、または未指定
429TOO_MANY_REQUESTSレート制限超過