Add hyperedge member

POST

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

POST

/api/v4/graphs/:graph_uuid/hyperedges/:hyperedge_uuid/edges

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.graph.hyperedge.create_edge(
    graph_uuid="graph_uuid",
    hyperedge_uuid="hyperedge_uuid",
    name="string",
)

{
  "edge": {
    "attributes": {},
    "expired_at": "2024-02-15T10:30:00Z",
    "fact": "Ada works at Acme Corp",
    "fact_name": "WORKS_AT",
    "invalid_at": "2024-02-15T10:30:00Z",
    "metadata": {},
    "source_node": {
      "attributes": {},
      "labels": [
        "Organization"
      ],
      "name": "Acme Corp",
      "summary": "A software company",
      "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    },
    "source_node_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "target_node": {
      "attributes": {},
      "labels": [
        "Organization"
      ],
      "name": "Acme Corp",
      "summary": "A software company",
      "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    },
    "target_node_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
    "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "valid_at": "2024-01-15T10:30:00Z"
  },
  "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"
  }
}

Adds one member edge to an existing hyperedge. The new member inherits the hyperedge’s fact and timestamps and joins its episodes, so only its own name and node pair are supplied.

Authentication

AuthorizationApi-Key

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

Path parameters

graph_uuidstringRequired

Graph UUID

hyperedge_uuidstringRequired

Hyperedge UUID

Request

Request body

namestringRequired

The name of the new member edge, in upper snake case.

source_nodeobjectRequired

The source node of the new member.

target_nodeobjectRequired

The target node of the new member.

Response

Accepted

edgeobjectOptional

An accept-time acknowledgement of the member edge, carrying the identifier Zep assigned and the hyperedge's shared fields.

taskobjectOptional

The asynchronous task that tracks writing the member edge.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error