Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.engramme.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

All API requests should be made to: 
https://memorymachines-gateway-prod-btf57kda.uc.gateway.dev

​
Authentication

Include your API key in the x-api-key header: 
export ENGRAMME_API_KEY="YOUR_API_KEY"

curl -X POST https://memorymachines-gateway-prod-btf57kda.uc.gateway.dev/v1/memories/recall \
  -H "x-api-key: $ENGRAMME_API_KEY" \
  -F "text=team meetings"
See Authentication for details.

​
Coding Agents

We know. You’re probably not going to read every page before opening your editor. Give your coding agent /llms.txt for the short version, or /llms-full.txt when you want it to have the full API context in one shot.

​
Endpoints

​
Memorize

MethodEndpointDescription
POST/v1/memorizeUpload a document

​
Memories

MethodEndpointDescription
POST/v1/memories/recallRecall raw memories
/v1/memories/ask is available but not part of the primary quickstart path yet. Feedback is currently handled by the Engramme app and SDK layer, not documented as a public REST endpoint in this API reference.

​
Files

MethodEndpointDescription
GET/v1/files/listList uploaded files for a source type
GET/v1/files/downloadDownload a file by item_id
DELETE/v1/files/{source_type}/{item_id}Delete a file

​
Health

MethodEndpointDescription
GET/v1/healthHealth check

​
Request Format

Memory endpoints accept multipart/form-data: 
curl -X POST https://memorymachines-gateway-prod-btf57kda.uc.gateway.dev/v1/memorize \
  -H "x-api-key: $ENGRAMME_API_KEY" \
  -F "file=@document.txt" \
  -F "user_name=Jane Doe" \
  -F "source_type=text"

​
Response Format

All responses are JSON: 
{
  "status": "success",
  "user_id": "user_abc123",
  "item_id": "document-123"
}

​
Error Handling

See Errors and Limits for status codes, retry guidance, upload limits, and rate limits.

​
SDKs

Python SDK

Install with pip install engramme
Or use any HTTP client directly (cURL, fetch, requests, etc.).