Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send the API generated from the Playground:

  • Authorization: <api_key>

Path Parameters

graph_id
string
required

The graph_id of the knowledge graph to be exported. A graph_id is an alphanumeric string that uniquely identifies a knowledge graph.

Query Parameters

cypher_query
boolean
default:false

Determines the structure of the graph object in the response. When false, the API returns a JSON object with graph.nodes and graph.relationships. When set to true, the response includes only the graph.cypher property, which contains the full graph in Cypher Query format.

Response

200 - application/json
graph
object
required

The exported graph data containing either graph.nodes and graph.relationships or graph.cypher.

last_graph_merge
object
required

Details about the most recent graph merge operation executed on this knowledge graph.

total_documents
integer
required
read-only

The total number of documents that have been processed to create or update the knowledge graph.

graph_name
string | null

The name of the knowledge graph being exported.