Get Subgraph Details
/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-Keyheader. - Bearer token in the
Authorizationheader.
Path parameters
| Name | Type | Description |
|---|---|---|
graph_idrequired | string | Graph Id |
subgraph_namerequired | string | Subgraph name (e.g., 'dev', 'staging') |
Example request
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
| Field | Type | Description |
|---|---|---|
graph_idrequired | string | Full subgraph identifier (e.g., kg123_dev) |
parent_graph_idrequired | string | Parent graph identifier |
subgraph_indexrequired | integer | Numeric index of the subgraph |
subgraph_namerequired | string | Alphanumeric name of the subgraph |
display_namerequired | string | Human-readable display name |
descriptionoptional | string | Description of the subgraph's purpose |
subgraph_typerequired | SubgraphType | Type of subgraph One of: |
statusrequired | string | Current status of the subgraph |
created_atrequired | string (date-time) | When the subgraph was created |
updated_atrequired | string (date-time) | When the subgraph was last updated |
size_bytesoptional | integer | On-disk footprint in bytes — the database, its write-ahead log, and its vector index. Prefer this over size_mb at subgraph scale. |
size_mboptional | number | Size of the subgraph database in megabytes |
node_countoptional | integer | Number of nodes in the subgraph |
edge_countoptional | integer | Number of edges in the subgraph |
last_accessedoptional | string (date-time) | When the subgraph was last accessed |
metadataoptional | object | Additional metadata for the subgraph |
| Status | Meaning |
|---|---|
| 400 | Invalid request |
| 401 | Authentication required |
| 403 | Access denied |
| 404 | Resource not found |
| 422 | Validation Error |
| 429 | Rate limit exceeded |
| 500 | Internal server error |