Get graph ontology

GET

https://api.getzep.com/api/v4/graphs/:graph_uuid/ontology

GET

/api/v4/graphs/:graph_uuid/ontology

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.graph.get_ontology(
    graph_uuid="graph_uuid",
)

{
  "edge_type_hierarchy": {},
  "edge_types": [
    {
      "description": "string",
      "name": "string",
      "properties": [
        {
          "description": "string",
          "name": "string",
          "protected": true,
          "type": "text"
        }
      ],
      "source_targets": [
        {
          "source": "string",
          "target": "string"
        }
      ]
    }
  ],
  "entity_type_hierarchy": {},
  "entity_types": [
    {
      "description": "string",
      "identity_properties": [
        "string"
      ],
      "name": "string",
      "properties": [
        {
          "description": "string",
          "name": "string",
          "protected": true,
          "type": "text"
        }
      ]
    }
  ],
  "inherited": true
}

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Path parameters

graph_uuidstringRequired

The UUID of the graph. For a user graph, you can also use the UUID of the user.

Response

edge_type_hierarchyobjectOptional

The edge type hierarchy. Omitted when the ontology has no edge subtypes.

edge_typeslist of objectsOptional

The edge types defined in the ontology in effect at this scope.

entity_type_hierarchyobjectOptional

The entity type hierarchy. Omitted when the ontology has no entity subtypes.

entity_typeslist of objectsOptional

The entity types defined in the ontology in effect at this scope.

inheritedbooleanOptional

Whether this is the project's default value rather than an override set on this graph.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error