Skip to main content
The engramme package is the official Python SDK for the Engramme API. Use it from notebooks, scripts, backend services, and internal tools.

Installation

The latest PyPI package is engramme, currently published as 0.1.1.

Quick Start

Memorization starts asynchronous processing. A successful memorize response means the upload was accepted and processing started; the content may not be immediately recallable.

Authentication

API key resolution order:
  1. Explicit api_key passed to Engramme(...)
  2. ENGRAMME_API_KEY
  3. Active profile in ~/.engramme/config.yaml
You can also save and manage a local key with the CLI:
Local credentials are stored in ~/.engramme/config.yaml. Override that path with ENGRAMME_CONFIG_PATH.

Methods

Engramme(...)

api_key
str
API key to use directly. If omitted, the SDK checks environment variables and local profiles.
profile
str
Local profile name from ~/.engramme/config.yaml.
base_url
str
API base URL.
timeout
int
default:"30"
Request timeout in seconds.

memorize(...)

Upload a document for memory extraction.
file
str | pathlib.Path | bytes
required
File path, pathlib.Path, or raw bytes to upload.
user_name
str
Name associated with the memories.
source_type
str
default:"text"
Type of content, such as text, email, pdf, github, or google_meets.
item_id
str
Optional stable identifier for the uploaded item.
filename
str
Filename to send when file is bytes.

recall(...)

Retrieve memories by semantic similarity.
text
str
required
Query text, max 1,000 characters.
source
str
Optional source filter.
enable_trace
bool
Include trace metadata when the API supports it.
alpha
float
Optional hybrid search weight between 0.0 and 1.0.

health_check()

Check API status.
Returns True when GET /v1/health returns HTTP 200.

Error Handling

Next Steps

API Reference

Full REST API documentation.

Authentication

API key best practices.