Schema

Export Declared Graph Schema

Returns the original schema definition from graph creation, not the runtime state. Set include_data_stats=true to add live node/relationship counts. Use /schema to inspect what's actually in the database.

get/v1/graphs/{graph_id}/schema/export

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}/schema/export
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Query parameters

formatstring

Export format: json, yaml, or cypher

include_data_statsboolean

Include statistics about actual data in the graph (node counts, relationship counts)

Response

Successful Response

graph_idstring required

Graph ID

formatstring required

Export format used

exported_atstring required

Export timestamp

data_statsobject nullable

Data statistics if requested (only when include_data_stats=true)

Example response

{
  "graph_id": "sec",
  "format": "json",
  "exported_at": "2025-10-29T10:30:00Z",
  "data_stats": {
    "node_counts": {
      "Company": 8500,
      "Filing": 125000,
      "Industry": 1200
    },
    "node_labels_count": 4,
    "node_properties_count": 12,
    "relationship_types_count": 3,
    "total_nodes": 134700
  }
}

Changes

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