Add hyperedge

POST

https://api.getzep.com/api/v4/graphs/:graph_uuid/hyperedges

POST

/api/v4/graphs/:graph_uuid/hyperedges

from zep_cloud import Zep, HyperedgeInput, EdgeNodeRef
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.graph.hyperedge.add(
    graph_uuid="graph_uuid",
    edges=[
        HyperedgeInput(
            name="string",
            source_node=EdgeNodeRef(),
            target_node=EdgeNodeRef(),
        )
    ],
    fact="string",
)

{
  "hyperedge": {
    "attributes": {},
    "edges": [
      {
        "name": "string",
        "source_node": {
          "attributes": {},
          "labels": [
            "Organization"
          ],
          "name": "Acme Corp",
          "summary": "A software company",
          "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
        },
        "target_node": {
          "attributes": {},
          "labels": [
            "Organization"
          ],
          "name": "Acme Corp",
          "summary": "A software company",
          "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
        },
        "uuid": "string"
      }
    ],
    "expired_at": "string",
    "fact": "string",
    "invalid_at": "string",
    "metadata": {},
    "uuid": "string",
    "valid_at": "string"
  },
  "task": {
    "completed_at": "string",
    "created_at": "string",
    "error": {
      "code": "string",
      "details": {},
      "message": "string",
      "param": "string",
      "request_id": "string"
    },
    "progress": {
      "stage": "string"
    },
    "result": {},
    "started_at": "string",
    "status": "string",
    "type": "string",
    "updated_at": "string",
    "uuid": "string"
  }
}

Creates one hyperedge: a fact that relates more than two nodes, written onto one member edge per node pair. The member edges must span at least three distinct nodes, since two nodes are a pair of edges rather than a hyperedge; a single pair uses graph.edge.add. Zep assigns the hyperedge identifier and every member edge identifier at accept time, and the members become readable when the task completes.

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Path parameters

graph_uuidstringRequired

Graph UUID

Request

Request body

edgeslist of objectsRequired

The member edges to create. Each pair becomes one edge carrying the shared fact.

factstringRequired

The natural-language fact, written onto every member edge.

attributesmap from strings to anyOptional

Additional attributes to store on every member edge.

expired_atstringOptional

The time at which the fact was superseded or invalidated.

invalid_atstringOptional

The time at which the fact stopped being true.

metadatamap from strings to anyOptional

Metadata attached to the episode created for this hyperedge.

valid_atstringOptional

The time at which the fact became true.

Response

Accepted

hyperedgeobjectOptional

An accept-time acknowledgement of the hyperedge you submitted.

taskobjectOptional

The asynchronous task that tracks writing the member edges.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error