---
title: "Get knowledge graph universe"
method: GET
path: "/knowledge_graph/universe"
tags: ["Analytics AI — Knowledge Graph"]
---

# Get knowledge graph universe

`GET /knowledge_graph/universe`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/knowledge_graph/universe`
- Auth: HTTP bearer

Sampled knowledge-graph view for visualization — not an unbounded export of every document.

## Query parameters

- `workspace_id` number
- `max_nodes` number
- `similarity_threshold` number
- `include_embeddings` boolean
- `include_entities` boolean
- `include_relations` boolean
- `compact` boolean

## Response `200`

Success

- object
  - `_billing` object
    - `credits` object
      - `total_monthly` integer
      - `remaining_monthly` integer
      - `credit_source` string
      - `api_handler` string
      - `tier_info` object
        - `tier` string
        - `name` string
        - `initial_credits` integer
        - `price_monthly` integer
        - `price_overage_per_credit` integer
      - `notice` string
      - `renewal_days` integer
      - `subscription_status` string
    - `job` object
      - `api_job_name` string
      - `app` string
      - `action` string
      - `default_credits` integer
      - `token` string
      - `credits_billed` integer
      - `pricing` object
        - `credits_per_unit` integer
        - `unit` string
        - `unit_count` integer
        - `addons` string
    - `requests` object
      - `limits` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `current` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `remaining` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `next_possible_request_seconds` integer
    - `remaining_credits` integer
    - `total_monthly` integer
    - `account_id` integer
    - `plan` object
      - `tier` string
      - `name` string
  - `clusters` object
    - `by_type` object[]
      - `type` string
      - `value` string
      - `label` string
      - `color` string
      - `icon` string
      - `count` integer
      - `doc_ids` unknown[]
        - unknown
    - `by_partner` unknown[]
      - unknown
  - `data_sources` object
    - `documents` integer
    - `meta_fields` integer
    - `embeddings` integer
    - `entities` integer
    - `relations` integer
    - `embedding_edges` integer
    - `entity_edges` integer
    - `relation_edges` integer
    - `meta_edges` integer
  - `graph` object
    - `nodes` object[]
      - `id` string
      - `label` string
      - `title` string
      - `shape` string
      - `color` object
        - `background` string
        - `border` string
        - `highlight` object
          - `background` string
          - `border` string
        - `hover` object
          - `background` string
          - `border` string
      - `borderWidth` integer
      - `font` object
        - `size` integer
        - `face` string
        - `color` string
        - `multi` string
      - `margin` object
        - `top` integer
        - `bottom` integer
        - `left` integer
        - `right` integer
      - `widthConstraint` object
        - `minimum` integer
        - `maximum` integer
      - `shadow` object
        - `enabled` boolean
        - `color` string
        - `size` integer
        - `x` integer
        - `y` integer
      - `data` object
        - `documents_id` integer
        - `pofid` string
        - `file_name` string
        - `document_type` string
        - `type_info` object
          - `label` string
          - `icon` string
          - `color` string
        - `partner` string
        - `amount` string
        - `currency` string
        - `created_datetime` string
        - `total_pages` integer
        - `references` unknown[]
          - unknown
        - `entities` unknown[]
          - unknown
        - `has_embedding` boolean
        - `thumbnail_url` string
    - `edges` unknown[]
      - unknown
    - `options` object
      - `nodes` object
        - `shape` string
        - `margin` object
          - `top` integer
          - `bottom` integer
          - `left` integer
          - `right` integer
        - `widthConstraint` object
          - `minimum` integer
          - `maximum` integer
        - `font` object
          - `size` integer
          - `face` string
          - `color` string
          - `multi` string
        - `borderWidth` integer
        - `shadow` object
          - `enabled` boolean
          - `color` string
          - `size` integer
          - `x` integer
          - `y` integer
      - `edges` object
        - `font` object
          - `size` integer
          - `align` string
          - `color` string
        - `smooth` object
          - `type` string
          - `roundness` number
        - `hoverWidth` integer
      - `physics` object
        - `enabled` boolean
        - `solver` string
        - `forceAtlas2Based` object
          - `gravitationalConstant` integer
          - `centralGravity` number
          - `springLength` integer
          - `springConstant` number
          - `damping` number
          - `avoidOverlap` number
        - `stabilization` object
          - `enabled` boolean
          - `iterations` integer
          - `updateInterval` integer
          - `fit` boolean
        - `minVelocity` number
      - `interaction` object
        - `hover` boolean
        - `tooltipDelay` integer
        - `hideEdgesOnDrag` boolean
        - `selectConnectedEdges` boolean
        - `navigationButtons` boolean
        - `keyboard` object
          - `enabled` boolean
          - `bindToWindow` boolean
        - `zoomSpeed` number
      - `layout` object
        - `improvedLayout` boolean
        - `randomSeed` integer
  - `processing_time` string
  - `scope` object
    - `tenant` string
    - `workspace_scope` string
    - `workspace_id` string
    - `sample_limit` integer
    - `sample_strategy` string
    - `scope_contract` string
  - `stats` object
    - `document_count` integer
    - `edge_count` integer
    - `cluster_count` integer
    - `type_clusters` integer
    - `partner_clusters` integer
    - `documents_with_embeddings` integer
    - `documents_with_entities` integer
  - `status` string
  - `tier` string
  - `workspace_id` string

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)