Introducing TheBrain API

Summary

Introducing TheBrain API explains the official REST API for accessing and manipulating data in your brains programmatically. It is designed for experienced programmers who want full control over thoughts, links, attachments, and notes from external code.

What You Can Do

• Read: fetch thoughts, links, attachments, and notes.
• Search & explore: query the network of connections in a brain.
• Write: create, modify, and delete thoughts, links, notes, and attachments.

Design & Audience

• A full‑featured REST API reachable over HTTPS.
• Intended for experienced programmers comfortable with HTTP, JSON, and authentication.
• Example projects are provided in:
  • Blazor
  • Python
  • Node.js

Typical Use Cases

• Custom dashboards, reports, or visualizations of your brain.
• Integrations with other systems (ticketing, documentation, CRMs, etc.).
• Automated import/export pipelines between TheBrain and other tools.

Relationship to Local API & ChatGPT

• The Local API gives you a local endpoint; the TheBrain API gives you a hosted, remote one.
• Both can be driven by scripts that also talk to services like OpenAI using your own API key.
• Together, they allow you to:
  • Pull information from TheBrain
  • Send it to ChatGPT or other AI models
  • Bring structured results back into your brain.