Getting Started with the Unize API for developers.
Create an account
Generate an API Key
POST
request to the /v1/storage/generate/
endpoint. The request requires the following parameters: api_key
, documents.text
, and documents.source_title
.
Here is an example of how to create a knowledge graph from text using Python:
execution_id
which you can use to visualize the graph or review the generated nodes and relationships.
execution_id
is a unique identifier for the generated graph. If you want to update an existing graph with new data, you can use the generated execution_id
for that existing graph the next time you make a request to the /v1/storage/generate/
endpoint.execution_id
of the generated graph, you can export the graph by making a POST
request to the /v1/storage/export/
endpoint. The request requires the following parameters: api_key
and execution_id
.
The cypher_query
parameter is optional and defaults to false
. When false
, the API returns a JSON object with arrays of nodes
and relationships
. If set to true
, the response will be a JSON object containing a Cypher Query string instead.
Check out the tabs below to see how to call the /v1/storage/export
endpoint and how the responses would look like depending on the value passed to cypher_query
parameter.
cypher_query
parameter to True
when calling the POST /v1/storage/export/
endpoint, Unize API will return the Cypher Query generated from processing your text. One way to visualize the graph is by using Neo4j’s AuraDB service. Copy the Cypher Query and paste it into your AuraDB instance to visualize the graph.