Skip to main content

Python client for the MindGraph Cloud API

Project description

mindgraph

PyPI License: MIT

Python client for the MindGraph Cloud API — a structured semantic memory graph for AI agents.

Install

pip install mindgraph-sdk

Quick Start

from mindgraph import MindGraph

with MindGraph("https://api.mindgraph.cloud", api_key="mg_...") as graph:
    # Add a node
    node = graph.add_node(
        label="User prefers dark mode",
        node_type="Preference",
    )

    # Search
    results = graph.search("what does the user prefer?")

    # Connect knowledge
    graph.add_link(
        from_uid=node["uid"],
        to_uid="user_abc",
        edge_type="BelongsTo",
    )

API Reference

Constructor

MindGraph(base_url, *, api_key=None, jwt=None, timeout=30.0)

Supports context manager protocol (with statement) for automatic cleanup.

Reality Layer

Method Description
capture(**kwargs) Capture a source, snippet, or observation
entity(**kwargs) Create, alias, resolve, or merge entities
find_or_create_entity(label, entity_type?, agent_id?) Convenience: create or find an entity by label

Epistemic Layer

Method Description
argue(**kwargs) Construct a full argument: claim + evidence + warrant + edges
inquire(**kwargs) Add hypothesis, theory, paradigm, anomaly, assumption, or question
structure(**kwargs) Add concept, pattern, mechanism, model, analogy, theorem, etc.

Intent Layer

Method Description
commit(**kwargs) Create a goal, project, or milestone
deliberate(**kwargs) Open decisions, add options/constraints, resolve decisions

Action Layer

Method Description
procedure(**kwargs) Build flows, add steps, affordances, and controls
risk(**kwargs) Assess risk or retrieve existing assessments

Memory Layer

Method Description
session(**kwargs) Open a session, record traces, or close a session
journal(label, props?, *, summary?, session_uid?, ...) Record a journal entry linked to an optional session
distill(**kwargs) Create a summary that distills multiple source nodes
memory_config(**kwargs) Set/get preferences and memory policies

Agent Layer

Method Description
plan(**kwargs) Create tasks, plans, plan steps, update status
governance(**kwargs) Create policies, set safety budgets, request/resolve approvals
execution(**kwargs) Track execution lifecycle and register agents

CRUD

Method Description
get_node(uid) Get a node by UID
add_node(label, node_type?, props?, agent_id?) Add a generic node
update_node(uid, **kwargs) Update node fields
delete_node(uid) Tombstone a node and all connected edges
add_link(from_uid, to_uid, edge_type, agent_id?) Add a typed edge
get_edges(from_uid?, to_uid?) Get edges by source or target

Search

Method Description
search(query, node_type?, layer?, limit?) Full-text search
hybrid_search(query, k?, node_types?, layer?) BM25 + vector search with rank fusion

Traversal

Method Description
reasoning_chain(uid, max_depth=5) Follow epistemic edges from a node
neighborhood(uid, max_depth=1) Get all nodes within N hops

Ingestion & Retrieval

Method Description
ingest_chunk(content, *, chunk_type?, ...) Ingest a single text chunk (sync): stores, embeds, and runs LLM extraction
ingest_document(content, *, title?, ...) Ingest a full document (async): chunks text, returns job ID
ingest_session(content, *, session_uid?, ...) Ingest a session transcript (async): links to session, returns job ID
retrieve_context(query, *, k?, depth?, ...) Retrieve semantically matched chunks + connected graph nodes/edges
get_job(job_id) Get async job status and progress
clear_graph() Clear all graph data

Lifecycle Shortcuts

Method Description
tombstone(uid, reason?, agent_id?) Soft-delete a node
restore(uid, agent_id?) Restore a tombstoned node

Cross-cutting

Method Description
retrieve(**kwargs) Unified retrieval: text search, active goals, open questions, weak claims
traverse(**kwargs) Graph traversal: chain, neighborhood, path, or subgraph
evolve(**kwargs) Lifecycle mutations: update, tombstone, restore, decay, history

Health & Stats

Method Description
health() Health check
stats() Graph-wide statistics

Management (Cloud only)

Method Description
signup(email, password) Create a new account
login(email, password) Login and receive JWT
create_api_key(name?) Create an API key
list_api_keys() List all API keys
revoke_api_key(key_id) Revoke an API key
get_usage() Get usage statistics

Examples

See examples/ for runnable demos, including a research continuity scenario showing cross-session memory retrieval.

Error Handling

All methods raise MindGraphError on HTTP errors:

from mindgraph import MindGraphError

try:
    graph.get_node("nonexistent")
except MindGraphError as e:
    print(e.status, e.body)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mindgraph_sdk-0.1.5.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mindgraph_sdk-0.1.5-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file mindgraph_sdk-0.1.5.tar.gz.

File metadata

  • Download URL: mindgraph_sdk-0.1.5.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mindgraph_sdk-0.1.5.tar.gz
Algorithm Hash digest
SHA256 4602533b0f4a4108a477366f601bc28cd11c299425c41e99eb9e5432368e8bf2
MD5 847f757cf8f73ce52dbaff975e719482
BLAKE2b-256 26b2fccb915368698056c1d09ffc97642b090971f8479a432559a332981e0db1

See more details on using hashes here.

Provenance

The following attestation bundles were made for mindgraph_sdk-0.1.5.tar.gz:

Publisher: publish.yml on shuruheel/mindgraph-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mindgraph_sdk-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: mindgraph_sdk-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mindgraph_sdk-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8f817b7cc53111fb7e88adb7eb6eefe78ca4af81caaac81115a5b81205e5b862
MD5 cd4a6a83291431a69643188fba38ae72
BLAKE2b-256 596de673502f267f9a43802052db6678088958316b79909e08818ccdd250b85e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mindgraph_sdk-0.1.5-py3-none-any.whl:

Publisher: publish.yml on shuruheel/mindgraph-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page