Subgraphs

Get Subgraph Details

Pass the subgraph name (e.g., dev) not the full subgraph ID (e.g., kg0123_dev).

get/v1/graphs/{graph_id}/subgraphs/{subgraph_name}

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/{graph_id}/subgraphs/{subgraph_name}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required
subgraph_namestring required

Subgraph name (e.g., 'dev', 'staging')

Response

Successful Response

graph_idstring required

Full subgraph identifier (e.g., kg123_dev)

parent_graph_idstring required

Parent graph identifier

subgraph_indexinteger required

Numeric index of the subgraph

subgraph_namestring required

Alphanumeric name of the subgraph

display_namestring required

Human-readable display name

descriptionstring nullable

Description of the subgraph's purpose

subgraph_type'static' | 'knowledge' | 'empty' required

Types of subgraphs.

statusstring required

Current status of the subgraph

created_atstring date-time required

When the subgraph was created

updated_atstring date-time required

When the subgraph was last updated

size_bytesinteger nullable

On-disk footprint in bytes — the database, its write-ahead log, and its vector index. Prefer this over size_mb at subgraph scale.

size_mbnumber nullable

Size of the subgraph database in megabytes

node_countinteger nullable

Number of nodes in the subgraph

edge_countinteger nullable

Number of edges in the subgraph

last_accessedstring date-time nullable

When the subgraph was last accessed

metadataobject nullable

Additional metadata for the subgraph

Example response

{
  "graph_id": "kg5f2e5e0da65d45d69645_dev",
  "parent_graph_id": "kg5f2e5e0da65d45d69645",
  "subgraph_index": 1,
  "subgraph_name": "dev",
  "display_name": "Development Environment",
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.