Browse the API reference

Get Subgraph Details

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

Part of Subgraphs.

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

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id
subgraph_namerequiredstringSubgraph name (e.g., 'dev', 'staging')

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/subgraphs/{subgraph_name}" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
graph_idrequiredstring

Full subgraph identifier (e.g., kg123_dev)

parent_graph_idrequiredstring

Parent graph identifier

subgraph_indexrequiredinteger

Numeric index of the subgraph

subgraph_namerequiredstring

Alphanumeric name of the subgraph

display_namerequiredstring

Human-readable display name

descriptionoptionalstring

Description of the subgraph's purpose

subgraph_typerequiredSubgraphType

Type of subgraph

One of: static, knowledge, empty

statusrequiredstring

Current status of the subgraph

created_atrequiredstring (date-time)

When the subgraph was created

updated_atrequiredstring (date-time)

When the subgraph was last updated

size_bytesoptionalinteger

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

size_mboptionalnumber

Size of the subgraph database in megabytes

node_countoptionalinteger

Number of nodes in the subgraph

edge_countoptionalinteger

Number of edges in the subgraph

last_accessedoptionalstring (date-time)

When the subgraph was last accessed

metadataoptionalobject

Additional metadata for the subgraph

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error