Where do I get an API key?

Settings → API Keys in the Alma web app. Create as many keys as you need; revoke any key from the same UI without affecting others. API access is included on the Max plan.

How do I authenticate?

Send X-API-Key: your-key in every request, or a JWT bearer token if you obtained one via the auth flow. API keys are HMAC-SHA256 hashed at rest, never stored in plaintext.

Is the chat endpoint streamed?

Yes. POST /api/v1/chat/conversations/:id/messages returns Server-Sent Events. The SDK handles parsing; for raw HTTP, the event delimiter is \n\n and the protocol matches Anthropic SSE shape.

Are there rate limits?

Yes — per-route and per-user. Image generation: 3 RPM. Web search: 20 RPM. General reads: generous. All limits return HTTP 429 with a Retry-After header; SDK retries automatically.

API Reference

The Alma REST API exposes 140+ endpoints under https://alma.olivares.ai/api/v1. Authenticate with an API key (X-API-Key header) or a JWT bearer token. Covers memories, episodes, procedures, Soul blocks, conversations, chat (SSE streaming), files, images, video, music, teams and more. Included with the Max plan ($99/mo) alongside the VSCode extension, MCP server, JavaScript SDK and BYOK.

Complete REST API with 140+ endpoints. Base URL: https://alma.olivares.ai/api/v1. Authentication via API keys (X-API-Key header) or JWT bearer tokens. Covers memories, episodes, procedures, blocks, conversations, chat (SSE streaming), files, images, teams, and more. Included with the Max plan ($99/mo), alongside the VSCode extension, MCP server, JavaScript SDK and BYOK.

See plans