Schema

Get Runtime Graph Schema

Runtime schema from actual graph data — node labels, relationship types, and up to 10 sample properties per node type. For the original schema definition or structured export formats, use /schema/export.

get/v1/graphs/{graph_id}/schema

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

Path parameters

graph_idstring required

Response

Successful Response

graph_idstring required

Graph database identifier

schemaobject required

Runtime schema information showing actual database structure

Example response

{
  "graph_id": "sec",
  "schema": {
    "node_labels": [
      "Entity",
      "Report",
      "Fact",
      "Element",
      "Period",
      "Unit",
      "Dimension",
      "Taxonomy",
      "Structure",
      "Association"
    ],
    "node_properties": {
      "Entity": {
        "cik": "STRING",
        "entity_type": "STRING",
        "fiscal_year_end": "STRING",
        "industry": "STRING",
        "name": "STRING",
        "state_of_incorporation": "STRING",
        "ticker": "STRING"
      },
      "Fact": {
        "decimals": "INT64",
        "fact_type": "STRING",
        "numeric_value": "DOUBLE"
      },
      "Report": {
        "accession_number": "STRING",
        "filing_date": "STRING",
        "form": "STRING",
        "name": "STRING",
        "report_date": "STRING"
      }
    },
    "relationship_types": [
      "ENTITY_HAS_REPORT",
      "REPORT_HAS_FACT",
      "FACT_HAS_ELEMENT",
      "FACT_HAS_PERIOD",
      "FACT_HAS_UNIT",
      "FACT_HAS_DIMENSION",
      "REPORT_USES_TAXONOMY",
      "STRUCTURE_HAS_TAXONOMY",
      "STRUCTURE_HAS_ASSOCIATION",
      "ASSOCIATION_HAS_FROM_ELEMENT",
      "ASSOCIATION_HAS_TO_ELEMENT"
    ]
  }
}

Changes

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