TheDocumentation Index
Fetch the complete documentation index at: https://docs.engramme.com/llms.txt
Use this file to discover all available pages before exploring further.
engramme package is the official Python SDK for the Engramme API. Use it from notebooks, scripts, backend services, and internal tools.
Installation
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
- Explicit
api_keypassed toEngramme(...) ENGRAMME_API_KEY- Active profile in
~/.engramme/config.yaml
~/.engramme/config.yaml. Override that path with ENGRAMME_CONFIG_PATH.
Methods
Engramme(...)
API key to use directly. If omitted, the SDK checks environment variables and local profiles.
Local profile name from
~/.engramme/config.yaml.API base URL.
Request timeout in seconds.
memorize(...)
Upload a document for memory extraction.
File path,
pathlib.Path, or raw bytes to upload.Name associated with the memories.
Type of content, such as
text, email, pdf, github, or google_meets.Optional stable identifier for the uploaded item.
Filename to send when
file is bytes.recall(...)
Retrieve memories by semantic similarity.
Query text, max 1,000 characters.
Optional source filter.
Include trace metadata when the API supports it.
Optional hybrid search weight between
0.0 and 1.0.health_check()
Check API status.
True when GET /v1/health returns HTTP 200.
Error Handling
| Exception | Cause |
|---|---|
AuthenticationError | Invalid API key |
RateLimitError | Too many requests |
NotFoundError | Resource not found |
ValidationError | Invalid parameters |
APIError | Other API errors |
Next Steps
API Reference
Full REST API documentation.
Authentication
API key best practices.

