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

Documentation Index

Fetch the complete documentation index at: https://docs.snorbe.deskrex.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
グラフデータ取得

指定したワークスペースのナレッジグラフデータを返します。UIの左側に表示される3Dグラフに相当するデータです。

​
リクエスト

GET /api/v1/graph/workspace

​
ヘッダー

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

​
クエリパラメータ

パラメータ型必須デフォルト説明
includeOthersEntitiesbooleanいいえfalse他のユーザーのエンティティを含めるか
nodeLimitintegerいいえ50取得するノードの最大数（1〜500）
edgeLimitintegerいいえ200取得するエッジの最大数（1〜1000）
ワークスペースは API キーに紐づくものが自動的に使用されます。workspaceId パラメータは不要です。

​
レスポンス

{
  "nodes": [
    {
      "id": "clxxx001",
      "label": "リチウムイオン電池",
      "category": "technology",
      "kind": "entity",
      "description": "充電可能な二次電池の一種",
      "communityId": 3,
      "pagerank": 0.045,
      "x": 12.5,
      "y": -8.3,
      "z": 4.1
    }
  ],
  "edges": [
    {
      "id": "clyyy001",
      "source": "clxxx001",
      "target": "clxxx002",
      "type": "related_to",
      "weight": 0.85,
      "edgeType": "relationship"
    }
  ],
  "fetchedAt": "2026-04-16T10:30:00.000Z",
  "nodeCount": 50,
  "edgeCount": 120,
  "totalEntityCount": 342
}

​
レスポンスフィールド

フィールド型説明
nodesobject[]グラフノード（エンティティ）の配列
nodes[].idstringエンティティ ID
nodes[].labelstringエンティティ名
nodes[].categorystringカテゴリ（例: technology, company）
nodes[].kindstringノード種別（entity, ghost）
nodes[].descriptionstringエンティティの説明
nodes[].communityIdnumber | nullコミュニティクラスタ ID
nodes[].pageranknumberPageRank スコア
nodes[].xnumber | nullX 座標（3D レイアウト）
nodes[].ynumber | nullY 座標（3D レイアウト）
nodes[].znumber | nullZ 座標（3D レイアウト）
edgesobject[]グラフエッジ（リレーション）の配列
edges[].idstringリレーション ID
edges[].sourcestring始点エンティティ ID
edges[].targetstring終点エンティティ ID
edges[].typestringリレーションタイプ
edges[].weightnumberエッジの重み（0〜1）
edges[].edgeTypestringエッジ種別（relationship）
fetchedAtstring取得日時（ISO 8601）
nodeCountnumber取得したノード数
edgeCountnumber取得したエッジ数
totalEntityCountnumberワークスペース内の全エンティティ数

​
使用例

curl "https://app.snorbe.deskrex.ai/api/v1/graph/workspace?nodeLimit=100&edgeLimit=500" \
  -H "Authorization: Bearer snorbe_your_api_key_here"

​
エラーレスポンス

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