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 Entity Detail

Returns detailed information about a specific entity, including its linked agent runs, relationships to other entities, and metadata.

​
Request

GET /api/v1/graph/entity/{entityId}

​
Path Parameters

ParameterTypeDescription
entityIdstringEntity ID

​
Headers

HeaderRequiredDescription
AuthorizationYesAPI key in Bearer snorbe_... format
The workspace is automatically resolved from your API key. No workspaceId parameter required.

​
Response

{
  "id": "clxxx001",
  "label": "Lithium-Ion Battery",
  "category": "technology",
  "kind": "entity",
  "description": "A type of rechargeable battery...",
  "metadata": {
    "url": { "value": "https://example.com/battery", "type": "text" }
  },
  "communityId": 3,
  "pagerank": 0.045,
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-03-20T14:22:00.000Z",
  "linkedEntities": [
    {
      "id": "clxxx002",
      "label": "Solid-State Electrolyte",
      "category": "technology",
      "kind": "material",
      "relationships": [
        { "direction": "outgoing", "type": "related_to", "weight": 0.85 }
      ]
    }
  ],
  "agentRuns": [
    {
      "id": "clrun001",
      "status": "completed",
      "process": [],
      "createdAt": "2026-04-01T09:00:00.000Z",
      "updatedAt": "2026-04-01T09:05:00.000Z",
      "agentId": "clagent001",
      "agentName": "research-agent",
      "linkedSources": [
        {
          "id": "clsrc001",
          "url": "https://example.com/paper",
          "title": "Research Paper",
          "sourceType": "public"
        }
      ],
      "linkedEntityIds": ["clxxx001", "clxxx002"],
      "linkedEntities": [
        {
          "id": "clxxx002",
          "label": "Solid-State Electrolyte",
          "category": "technology",
          "kind": "material"
        }
      ]
    }
  ]
}
Returns null if the entity is not found in the workspace.

​
Response Fields

FieldTypeDescription
idstringEntity ID
labelstringEntity name
categorystringCategory (e.g., technology, company)
kindstringNode kind (entity, ghost)
descriptionstringEntity description
metadataobject | nullKey-value metadata attached to the entity. Each value has a value (string) and type (string) field
communityIdnumberCommunity cluster ID
pageranknumberPageRank score
createdAtstringCreation timestamp (ISO 8601)
updatedAtstringLast update timestamp (ISO 8601)
linkedEntitiesobject[]Entities directly connected to this entity via graph edges
linkedEntities[].idstringLinked entity ID
linkedEntities[].labelstringLinked entity name
linkedEntities[].categorystringLinked entity category
linkedEntities[].kindstringLinked entity kind
linkedEntities[].relationshipsobject[]Relationship descriptors between the two entities
linkedEntities[].relationships[].directionstringEdge direction (outgoing or incoming)
linkedEntities[].relationships[].typestringRelationship type (e.g., related_to)
linkedEntities[].relationships[].weightnumberEdge weight (0-1)
agentRunsobject[]Agent runs linked to this entity
agentRuns[].idstringAgent run ID
agentRuns[].statusstringRun status (completed, running, error, etc.)
agentRuns[].processobject[]Array of process events from the agent run
agentRuns[].createdAtstringRun creation timestamp (ISO 8601)
agentRuns[].updatedAtstringRun last update timestamp (ISO 8601)
agentRuns[].agentIdstringAgent ID that executed this run
agentRuns[].agentNamestringAgent name
agentRuns[].linkedSourcesobject[]Sources used in this agent run
agentRuns[].linkedSources[].idstringSource ID
agentRuns[].linkedSources[].urlstringSource URL
agentRuns[].linkedSources[].titlestringSource title
agentRuns[].linkedSources[].sourceTypestringSource type (public or private)
agentRuns[].linkedEntityIdsstring[]Entity IDs linked to this agent run
agentRuns[].linkedEntitiesobject[]Entity summaries linked to this agent run
agentRuns[].linkedEntities[].idstringEntity ID
agentRuns[].linkedEntities[].labelstringEntity name
agentRuns[].linkedEntities[].categorystringEntity category
agentRuns[].linkedEntities[].kindstringEntity kind
The process field in each agent run is an array of process events. See the SSE streaming docs for the full list of event types and their payloads.

​
Examples

curl "https://app.snorbe.deskrex.ai/api/v1/graph/entity/clxxx001" \
  -H "Authorization: Bearer snorbe_your_api_key_here"

​
Error Responses

HTTP StatusDescription
401Invalid, expired, or missing API key
404Entity not found (returns null body)