Create Graph

JavaScript

import Morphik from 'morphik';

const client = new Morphik({
  apiKey: 'My API Key',
});

const graph = await client.graph.create({ name: 'name' });

console.log(graph.id);

{
  "name": "<string>",
  "id": "<string>",
  "entities": [
    {
      "label": "<string>",
      "type": "<string>",
      "id": "<string>",
      "properties": {},
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "relationships": [
    {
      "source_id": "<string>",
      "target_id": "<string>",
      "type": "<string>",
      "id": "<string>",
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "metadata": {},
  "system_metadata": {},
  "document_ids": [
    "<string>"
  ],
  "filters": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "folder_name": "<string>",
  "end_user_id": "<string>",
  "app_id": "<string>"
}

POST

graph

create

JavaScript

import Morphik from 'morphik';

const client = new Morphik({
  apiKey: 'My API Key',
});

const graph = await client.graph.create({ name: 'name' });

console.log(graph.id);

{
  "name": "<string>",
  "id": "<string>",
  "entities": [
    {
      "label": "<string>",
      "type": "<string>",
      "id": "<string>",
      "properties": {},
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "relationships": [
    {
      "source_id": "<string>",
      "target_id": "<string>",
      "type": "<string>",
      "id": "<string>",
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "metadata": {},
  "system_metadata": {},
  "document_ids": [
    "<string>"
  ],
  "filters": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "folder_name": "<string>",
  "end_user_id": "<string>",
  "app_id": "<string>"
}

Headers

authorization

string

Body

application/json

Request model for creating a graph

name

string

required

Name of the graph to create

filters

Filters · object

Optional metadata filters to determine which documents to include

documents

string[] | null

Optional list of specific document IDs to include

prompt_overrides

GraphPromptOverrides · object

Optional customizations for entity extraction and resolution prompts

Show child attributes

prompt_overrides.entity_extraction

EntityExtractionPromptOverride · object

Overrides for entity extraction prompts - controls how entities are identified in text during graph operations

Show child attributes

prompt_overrides.entity_extraction.prompt_template

string | null

Custom prompt template, MUST include both {content} and {examples} placeholders. The {content} placeholder will be replaced with the text to analyze, and {examples} will be replaced with formatted examples.

prompt_overrides.entity_extraction.examples

EntityExtractionExample · object[] | null

Examples of entities to extract, used to guide the LLM toward domain-specific entity types and patterns.

Show child attributes

prompt_overrides.entity_extraction.examples.label

string

required

The entity label (e.g., 'John Doe', 'Apple Inc.')

prompt_overrides.entity_extraction.examples.type

string

required

The entity type (e.g., 'PERSON', 'ORGANIZATION', 'PRODUCT')

prompt_overrides.entity_extraction.examples.properties

Properties · object

Optional properties of the entity (e.g., {'role': 'CEO', 'age': 42})

prompt_overrides.entity_resolution

EntityResolutionPromptOverride · object

Overrides for entity resolution prompts - controls how variant forms are grouped during graph operations

Show child attributes

prompt_overrides.entity_resolution.prompt_template

string | null

Custom prompt template that MUST include both {entities_str} and {examples_json} placeholders. The {entities_str} placeholder will be replaced with the extracted entities, and {examples_json} will be replaced with JSON-formatted examples of entity resolution groups.

prompt_overrides.entity_resolution.examples

EntityResolutionExample · object[] | null

Examples of entity resolution groups showing how variants of the same entity should be resolved to their canonical forms. This is particularly useful for domain-specific terminology, abbreviations, and naming conventions.

Show child attributes

prompt_overrides.entity_resolution.examples.canonical

string

required

The canonical (standard/preferred) form of the entity

prompt_overrides.entity_resolution.examples.variants

string[]

required

List of variant forms that should resolve to the canonical form

Example:

{
  "entity_extraction": {
    "examples": [{ "label": "Example", "type": "ENTITY" }],
    "prompt_template": "Extract entities from the following text: {content}\n{examples}"
  }
}

folder_name

Optional folder scope for the operation. Accepts a single folder name or a list of folder names.

end_user_id

string | null

Optional end-user scope for the operation

Response

Successful Response

Represents a knowledge graph

name

string

required

string

entities

Entity · object[]

Show child attributes

entities.label

string

required

entities.type

string

required

entities.id

string

entities.properties

Properties · object

entities.document_ids

string[]

entities.chunk_sources

Chunk Sources · object

Show child attributes

entities.chunk_sources.{key}

integer[]

relationships

Relationship · object[]

Show child attributes

relationships.source_id

string

required

relationships.target_id

string

required

relationships.type

string

required

relationships.id

string

relationships.document_ids

string[]

relationships.chunk_sources

Chunk Sources · object

Show child attributes

relationships.chunk_sources.{key}

integer[]

metadata

Metadata · object

system_metadata

System Metadata · object

document_ids

string[]

filters

Filters · object

created_at

string<date-time>

updated_at

string<date-time>

folder_name

string | null

end_user_id

string | null

app_id

string | null

Get Logs Get Graph

⌘I

Getting Started

API Reference

models

health

Ingestion

Documents

Folders

document

model-config

Logs

Graph

EE - Connectors

Headers

Body

Response