Skip to main content

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
series(**kwargs) Call the time-series action surface directly
create_series / append_series / series_window Create a Series, append sourced points, and page through a bounded time window
aggregate_series / latest_series / list_series_for_entity Read bounded aggregates, cached latest values, and an entity's Series
batch_latest_series / batch_aggregate_series / delete_series Compare Series across entities or tombstone a Series and its points
find_or_create_entity(label, props?, agent_id?) Convenience: create or find an entity by label (generic fallback)
find_or_create_person(label, props?, agent_id?) Find or create a Person entity
find_or_create_organization(label, props?, agent_id?) Find or create an Organization entity
find_or_create_nation(label, props?, agent_id?) Find or create a Nation entity
find_or_create_event(label, props?, agent_id?) Find or create an Event entity
find_or_create_place(label, props?, agent_id?) Find or create a Place entity
find_or_create_concept(label, props?, agent_id?) Find or create a Concept entity
add_claim(label, content, confidence?, agent_id?) Add a Claim node via the argument endpoint
add_evidence(label, description, agent_id?) Add an Evidence node attached to a claim
add_observation(label, description, agent_id?) Add an Observation node

Typed entity example:

person = graph.find_or_create_person("Marie Curie", props={"nationality": "Polish"})
org = graph.find_or_create_organization("CERN", props={"org_type": "intergovernmental"})
concept = graph.find_or_create_concept("Nuclear Physics")

# find_or_create_entity() still works as a generic fallback for any entity type
entity = graph.find_or_create_entity("Some Entity")

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
resolve_decision(...) Resolve with optional informs_uid, as_of_date, session_id, and retrieval_trace_id linkage

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, Lesson, or governed Skill candidate with source provenance
memory_config(**kwargs) Set/get preferences and memory policies

output_type="skill" requires caller-authored SKILL.md content and at least one provenance field. It always creates a candidate for review:

graph.distill(
    label="Recover a malformed import",
    output_type="skill",
    work_uid="work_import_42",
    props={
        "name": "recover-malformed-import",
        "description": "Use after a spreadsheet import fails schema validation.",
        "content": "# Recovery\n\nValidate headers, normalize dates, then retry.",
    },
)

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

Synthesis (Projects)

Scope a corpus to a Project (via commit(action="project", ...) then link documents with PartOfProject), then mine cross-document signals and generate synthesis articles.

Method Description
signals(project_uid, *, signals?, target_types?) Mine cross-document structural signals for a project
run_synthesis(project_uid) Spawn async synthesis job that turns top clusters into Article nodes; returns {"job_id": ...}
project = graph.commit(action="project", label="Q2 China strategy")
# ...link documents to the project via PartOfProject edges...
signals = graph.signals(project["uid"], signals="clustered_claim_hubs,dialectical_pairs")
job = graph.run_synthesis(project["uid"])
status = graph.get_job(job["job_id"])

Operational Ontology (Layer 7)

Define typed domain objects (Customer, Order, Contract…) as a semantic contract and either bind them to a SQL database or extract them from documents — fused onto one object. Connecting a database (credentials/sync) is done in the dashboard; the SDK proposes/reviews schemas, queries, and lists the generated agent read tools.

Method Description
propose_ontology_schema(...) Draft a schema from a description (+ optional sample docs); returns {"schema_id", "job_id"}
activate_ontology_schema(id) / get_ontology_schema(id) / list_ontology_schemas() Schema lifecycle
create_ontology_series_binding / sync_ontology_series_binding / archive_ontology_series_binding Manage SQL-backed dense-measurement bindings
list_ontology_proposals(...) / approve_ontology_proposal(id) / reject_ontology_proposal(id) Review extracted-object proposals
query_ontology(query=..., schema_id=...) Typed retrieval with the cognitive overlay fused in
list_ontology_tools() The generated read-tool manifest (search_/get_/summarize_<obj>) the MCP server renders
res = graph.propose_ontology_schema(description="Clients, orders, contracts.")
graph.activate_ontology_schema(res["schema_id"])
tools = graph.list_ontology_tools()
ctx = graph.query_ontology(query="Which customers are a churn risk?", schema_id=res["schema_id"])

See the Operational Ontology and Connect a database docs.

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?, explain?) BM25 + vector search with rank fusion; explain=True attaches per-leg contributions (legs: which legs surfaced each result, the within-leg rank the fusion used, and the leg's raw score)
merge_candidates() Pending duplicate pairs recorded by the dedup pipeline, awaiting merge/dismiss

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, *, graph_expansion_limit?, graph_max_depth?, ...) Direct retrieval plus optional cheapest-first graph expansion
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) Budgeted min-cost traversal; response depth is witness-path hops
evolve(**kwargs) Lifecycle mutations: update, tombstone, restore, decay, history

Health & Stats

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

Account sign-up, login, and API key management live in the MindGraph dashboard — not the SDK. Get your API key there, then pass it to the MindGraph constructor.

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

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.15.1.tar.gz (47.8 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.15.1-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mindgraph_sdk-0.15.1.tar.gz
  • Upload date:
  • Size: 47.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mindgraph_sdk-0.15.1.tar.gz
Algorithm Hash digest
SHA256 da20b86eceaff20bea72e07dd917e585f4ab4732aa9aaa7c4d16e43928b40b7d
MD5 3516fd65eb255e7f2a2cbfbdd0369de9
BLAKE2b-256 b7d52cc7bb21415e2d5cc8019e7801f0a15481386a93afd80a54207f542ad767

See more details on using hashes here.

Provenance

The following attestation bundles were made for mindgraph_sdk-0.15.1.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.15.1-py3-none-any.whl.

File metadata

  • Download URL: mindgraph_sdk-0.15.1-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mindgraph_sdk-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eef5d3b72134e4ade68d5a8b99137a1bc9c01ea6ce62d1ff6bf4e82eda7a5e0b
MD5 b1cf4dd0738626ff51e4423373e59baa
BLAKE2b-256 b8316a629be7bb299622ad8cabb5f26b456fc8885afde4e66f0957a9d51fb2f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for mindgraph_sdk-0.15.1-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.

Release history Release notifications | RSS feed

This release

0.15.1 This release

2 files

0.15.0

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page