Skip to main content
POST
/
v1
/
storage
/
cURL
curl --request POST \
  --url https://api.unize.org/v1/storage/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "graph_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "graph_name": "<string>",
  "extraction_criteria": "<string>",
  "documents": [
    {
      "text": "<string>",
      "source_title": "<string>",
      "source_url": "<string>",
      "source_author": "<string>",
      "source_article_date": "<string>",
      "override_extraction_criteria": "<string>"
    }
  ],
  "system": "st-0.75",
  "extraction_mode": "normal"
}'
{
  "graph_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Send the API generated from the Playground:

  • Authorization: <api_key>

Body

​
documents
object[]
required

List of documents to be processed. A minimum of 1 document is required.

Minimum length: 1
​
graph_id
string<uuid>

An alphanumeric string that uniquely identifies a generated knowledge graph. Provide the graph_id of an existing knoweldge graph to add new data to it. If omitted, a new knoweldge graph will be created instead of updating an existing one.

​
graph_name
string

A unique identifier or label for the knowledge graph being imported. It should be descriptive enough to indicate the graph's content, purpose, or source (e.g., 'medical_research_graph' or 'customer_support_kg'). If not provided, defaults to source_title of the first document.

​
extraction_criteria
string

Specify the criteria that the system must follow when generating the knoweldge graph. This parameter is only applicable when extraction_mode is set to user_defined. If extraction_criteria is provided while extraction_mode is set to any value other than user_defined, the API will return an error.

Required string length: 10 - 750
​
system
enum<string>
default:st-0.75
  • st-0.75 (default) - newest, more accurate, and cheapest Storage system
  • st-0.5 (legacy) - only works with normal and user-defined extraction modes
Available options:
st-0.75,
st-0.5
​
extraction_mode
enum<string>
default:normal
  • normal - extracts all key entities (e.g. 'John Doe') and their relationships
  • detailed - extracts all entities and relationships
  • user_defined - extracts all entities and relationships based on the extraction_criteria provided by the user
Available options:
normal,
detailed,
user_defined

Response

202 - application/json
​
graph_id
string<uuid>
required

An alphanumeric string that uniquely identifies the generated knowledge graph.