Authorizations
Send the API generated from the Playground:
Authorization: <api_key>
Body
List of documents to be processed. A minimum of 1 document is required.
1
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.
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.
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.
10 - 750
st-0.75
(default) - newest, more accurate, and cheapest Storage systemst-0.5
(legacy) - only works with normal and user-defined extraction modes
st-0.75
, st-0.5
normal
- extracts all key entities (e.g. 'John Doe') and their relationshipsdetailed
- extracts all entities and relationshipsuser_defined
- extracts all entities and relationships based on theextraction_criteria
provided by the user
normal
, detailed
, user_defined
Response
An alphanumeric string that uniquely identifies the generated knowledge graph.