Skip to main content
GET
/
graph
/
{name}
JavaScript
import Morphik from 'morphik';

const client = new Morphik({
  apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});

const graph = await client.graph.retrieve('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>",
  "folder_path": "<string>"
}

Headers

authorization
string

Path Parameters

name
string
required

Query Parameters

folder_name
folder_depth
integer | null

Folder scope depth: 0/None exact, -1 all descendants, n>0 include descendants up to n levels.

end_user_id
string | null

Response

Successful Response

Represents a knowledge graph

name
string
required
id
string
entities
Entity · object[]
relationships
Relationship · object[]
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
folder_path
string | null