Skip to main content

Case Graph

Retrieve the D3-compatible graph visualization for a single case, showing document nodes and entity edges within the case boundary.

GET/v1/cases/{id}/graph

Response

Response fields

nodesarrayDocument and entity nodes within the case.
nodes[].idstringNode ID. Document UUIDs or entity IDs prefixed with "entity:".
nodes[].typestring"document" or "entity".
nodes[].labelstringFilename or entity value.
edgesarrayEdges between document and entity nodes.
edges[].sourcestringDocument node ID.
edges[].targetstringEntity node ID.
edges[].field_keystringField name where the shared value was found.
edges[].categorystringLink key category of the entity.

Response

{
  "nodes": [
    { "id": "doc_uuid_1", "type": "document", "label": "Invoice-001.pdf", "document_type": "Invoice" },
    { "id": "doc_uuid_2", "type": "document", "label": "PO-2024-001.pdf", "document_type": "Purchase Order" },
    { "id": "entity:ent_uuid_1", "type": "entity", "label": "PO-2024-001", "category": "transaction" }
  ],
  "edges": [
    { "source": "doc_uuid_1", "target": "entity:ent_uuid_1", "field_key": "po_number", "category": "transaction" },
    { "source": "doc_uuid_2", "target": "entity:ent_uuid_1", "field_key": "po_number", "category": "transaction" }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Cases
Full Graph