Skip to main content

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.

Get Graph Data

Returns the knowledge graph data for the workspace associated with your API key. This corresponds to the 3D graph displayed on the left side of the UI.

Request

GET /api/v1/graph/workspace

Headers

HeaderRequiredDescription
AuthorizationYesAPI key in Bearer snorbe_... format

Query Parameters

ParameterTypeRequiredDefaultDescription
includeOthersEntitiesbooleanNofalseInclude other users’ entities
nodeLimitintegerNo50Maximum number of nodes to return (1–500)
edgeLimitintegerNo200Maximum number of edges to return (1–1000)
The workspace is automatically resolved from your API key. No workspaceId parameter required.

Response

{
  "nodes": [
    {
      "id": "clxxx001",
      "label": "Lithium-Ion Battery",
      "category": "technology",
      "kind": "entity",
      "description": "A type of rechargeable battery",
      "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
}

Response Fields

FieldTypeDescription
nodesobject[]Array of graph nodes (entities)
nodes[].idstringEntity ID
nodes[].labelstringEntity name
nodes[].categorystringCategory (e.g., technology, company)
nodes[].kindstringNode kind (entity, ghost)
nodes[].descriptionstringEntity description
nodes[].communityIdnumber | nullCommunity cluster ID
nodes[].pageranknumberPageRank score
nodes[].xnumber | nullX coordinate (3D layout)
nodes[].ynumber | nullY coordinate (3D layout)
nodes[].znumber | nullZ coordinate (3D layout)
edgesobject[]Array of graph edges (relationships)
edges[].idstringRelationship ID
edges[].sourcestringSource entity ID
edges[].targetstringTarget entity ID
edges[].typestringRelationship type
edges[].weightnumberEdge weight (0–1)
edges[].edgeTypestringEdge kind (relationship)
fetchedAtstringFetch timestamp (ISO 8601)
nodeCountnumberNumber of nodes returned
edgeCountnumberNumber of edges returned
totalEntityCountnumberTotal entity count in workspace

Examples

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

Error Responses

HTTP StatusCodeDescription
401UNAUTHORIZEDInvalid, expired, or missing API key
429TOO_MANY_REQUESTSRate limit exceeded