Documentation

3. Create your first entity

from hyperx import HyperX

# Initialize client with your API key
db = HyperX(api_key="hx_sk_...")

# Create an entity
entity = db.entities.create(
    name="Machine Learning",
    entity_type="concept",
    attributes={
        "description": "A subset of AI focused on learning from data"
    }
)

# Create more entities
data = db.entities.create(name="Data", entity_type="concept")
compute = db.entities.create(name="Compute", entity_type="resource")

# Create a hyperedge connecting multiple entities
edge = db.hyperedges.create(
    description="ML requires Data and Compute",
    members=[
        {"entity_id": entity.id, "role": "subject"},
        {"entity_id": data.id, "role": "requirement"},
        {"entity_id": compute.id, "role": "requirement"},
    ]
)