POST
/
graph
/
create
curl --request POST \
  --url http://localhost:8000/graph/create \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "filters": {},
  "documents": [
    "<string>"
  ],
  "prompt_overrides": {
    "entity_extraction": {
      "examples": [
        {
          "label": "Example",
          "type": "ENTITY"
        }
      ],
      "prompt_template": "Extract entities from the following text: {content}\n{examples}"
    }
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "entities": [
    {
      "id": "<string>",
      "label": "<string>",
      "type": "<string>",
      "properties": {},
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "relationships": [
    {
      "id": "<string>",
      "source_id": "<string>",
      "target_id": "<string>",
      "type": "<string>",
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "metadata": {},
  "document_ids": [
    "<string>"
  ],
  "filters": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "owner": {},
  "access_control": {}
}

Headers

​
authorization
string

Body

application/json

Request model for creating a graph

​
name
string
required

Name of the graph to create

​
filters
object | null

Optional metadata filters to determine which documents to include

​
documents
string[] | null

Optional list of specific document IDs to include

​
prompt_overrides
object | null

Optional customizations for entity extraction and resolution prompts

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

Response

200
application/json
Successful Response

Represents a knowledge graph

​
name
string
required
​
id
string
​
entities
object[]

Represents an entity in a knowledge graph

​
relationships
object[]

Represents a relationship between entities in a knowledge graph

​
metadata
object
​
document_ids
string[]
​
filters
object | null
​
created_at
string
​
updated_at
string
​
owner
object
​
access_control
object