RoboSystems
Browse the API reference
Overview

Export Declared Graph Schema

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

Part of 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.

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

Query parameters

NameTypeDescription
formatoptionalstringExport format: json, yaml, or cypher

Default: "json"

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

Default: false

Example request

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

Responses

200 Successful Response

FieldTypeDescription
graph_idrequiredstring

Graph ID

schema_definitionrequiredobject | string

Exported schema definition (format depends on 'format' parameter)

formatrequiredstring

Export format used

exported_atrequiredstring

Export timestamp

data_statsoptionalobject

Data statistics if requested (only when include_data_stats=true)

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