# Documentation

- [Introduction](https://docs.crosmos.dev/index.md): Context engineering for AI agents
- [Quickstart](https://docs.crosmos.dev/quickstart.md): Get started with Crosmos
- [How Crosmos Works](https://docs.crosmos.dev/how-it-works.md): Why standard RAG fails at memory, and how Crosmos does it differently
- [Memories](https://docs.crosmos.dev/memories.md): Store and retrieve memories for AI agents
- [Knowledge Graph](https://docs.crosmos.dev/mtkg.md): How Crosmos structures, stores, and retrieves knowledge over time
- [Forgetting](https://docs.crosmos.dev/forgetting.md): How Crosmos decides what to keep, what to fade, and what to let go
- [Recall](https://docs.crosmos.dev/recall.md): How Crosmos finds what it knows, fast
- [Clusters](https://docs.crosmos.dev/clusters.md): How Crosmos compresses, consolidates, and organizes memories in the background
- [MCP](https://docs.crosmos.dev/mcp/overview.md): Connect Crosmos to AI clients with the Model Context Protocol.
- [Tools](https://docs.crosmos.dev/mcp/tools.md): MCP tool schemas and examples for Crosmos memory.
- [Configuration](https://docs.crosmos.dev/mcp/configuration.md): Configure authentication, spaces, timeouts, and deployment for the Crosmos MCP server.
- [Skills](https://docs.crosmos.dev/mcp/skills.md): Install the Crosmos skill so AI editors use memory tools automatically.
- [SDKs](https://docs.crosmos.dev/sdks.md): Build Crosmos memory into your application with official SDKs.
- [Advanced](https://docs.crosmos.dev/sdks/advanced.md): Configure SDK clients, retries, errors, logging, and raw responses.
- [Claude Code](https://docs.crosmos.dev/plugins/claude-code.md): Add automatic, persistent context to Claude Code.
- [Codex](https://docs.crosmos.dev/plugins/codex.md): Add automatic, persistent context to the OpenAI Codex CLI.
- [Hermes](https://docs.crosmos.dev/plugins/hermes.md): Add automatic, persistent context to Hermes Agent.
- [OpenCode](https://docs.crosmos.dev/plugins/opencode.md): Add automatic, persistent context to OpenCode.
- [Quickstart](https://docs.crosmos.dev/toolkit/graph/quickstart.md): Install @crosmos/graph and render a force-directed knowledge graph in any React app.
- [Reference](https://docs.crosmos.dev/toolkit/graph/reference.md): Props, imperative handle, clustering behaviour, and SSR notes for @crosmos/graph.
- [Theme](https://docs.crosmos.dev/toolkit/graph/theme.md): Every theme key in @crosmos/graph, with defaults, and the CSS variables that drive the zoom indicator.
- [Get current user](https://docs.crosmos.dev/api-reference/auth/get-current-user.md)
- [Update current user](https://docs.crosmos.dev/api-reference/auth/update-current-user.md)
- [Switch active organization](https://docs.crosmos.dev/api-reference/auth/switch-active-organization.md)
- [List API keys](https://docs.crosmos.dev/api-reference/auth/list-api-keys.md)
- [Create API key](https://docs.crosmos.dev/api-reference/auth/create-api-key.md)
- [Validate an API key](https://docs.crosmos.dev/api-reference/auth/validate-an-api-key.md): Returns 200 if the key in the Authorization header is valid. Returns 401 otherwise.
- [Revoke API key](https://docs.crosmos.dev/api-reference/auth/revoke-api-key.md)
- [Exchange refresh token for new pair](https://docs.crosmos.dev/api-reference/auth/exchange-refresh-token-for-new-pair.md)
- [Revoke refresh token (idempotent)](https://docs.crosmos.dev/api-reference/auth/revoke-refresh-token-idempotent.md)
- [List available OAuth providers](https://docs.crosmos.dev/api-reference/oauth-consumer/list-available-oauth-providers.md)
- [Build OAuth authorize URL](https://docs.crosmos.dev/api-reference/oauth-consumer/build-oauth-authorize-url.md)
- [Exchange OAuth code for tokens](https://docs.crosmos.dev/api-reference/oauth-consumer/exchange-oauth-code-for-tokens.md)
- [List the caller's organizations](https://docs.crosmos.dev/api-reference/organizations/list-the-callers-organizations.md)
- [Accept organization invite](https://docs.crosmos.dev/api-reference/organizations/accept-organization-invite.md)
- [Preview organization invite](https://docs.crosmos.dev/api-reference/organizations/preview-organization-invite.md)
- [List organization members](https://docs.crosmos.dev/api-reference/organizations/list-organization-members.md)
- [Remove organization member](https://docs.crosmos.dev/api-reference/organizations/remove-organization-member.md)
- [Update organization member role](https://docs.crosmos.dev/api-reference/organizations/update-organization-member-role.md)
- [List organization invites](https://docs.crosmos.dev/api-reference/organizations/list-organization-invites.md)
- [Create organization invite](https://docs.crosmos.dev/api-reference/organizations/create-organization-invite.md)
- [Revoke organization invite](https://docs.crosmos.dev/api-reference/organizations/revoke-organization-invite.md)
- [Get organization detail](https://docs.crosmos.dev/api-reference/organizations/get-organization-detail.md)
- [Update organization (owner/admin only)](https://docs.crosmos.dev/api-reference/organizations/update-organization-owneradmin-only.md)
- [Get organization entitlements + this month's usage](https://docs.crosmos.dev/api-reference/organizations/get-organization-entitlements-+-this-months-usage.md)
- [Get apiv1orgs visibilitygroups](https://docs.crosmos.dev/api-reference/visibility/get-apiv1orgs-visibilitygroups.md)
- [Post apiv1orgs visibilitygroups](https://docs.crosmos.dev/api-reference/visibility/post-apiv1orgs-visibilitygroups.md)
- [Delete apiv1orgs visibilitygroups](https://docs.crosmos.dev/api-reference/visibility/delete-apiv1orgs-visibilitygroups.md)
- [Patch apiv1orgs visibilitygroups](https://docs.crosmos.dev/api-reference/visibility/patch-apiv1orgs-visibilitygroups.md)
- [Get apiv1orgs visibilitygroups members](https://docs.crosmos.dev/api-reference/visibility/get-apiv1orgs-visibilitygroups-members.md)
- [Post apiv1orgs visibilitygroups members](https://docs.crosmos.dev/api-reference/visibility/post-apiv1orgs-visibilitygroups-members.md)
- [Delete apiv1orgs visibilitygroups members](https://docs.crosmos.dev/api-reference/visibility/delete-apiv1orgs-visibilitygroups-members.md)
- [Get apiv1orgs visibilitygrants](https://docs.crosmos.dev/api-reference/visibility/get-apiv1orgs-visibilitygrants.md)
- [Post apiv1orgs visibilitygrants](https://docs.crosmos.dev/api-reference/visibility/post-apiv1orgs-visibilitygrants.md)
- [Post apiv1orgs visibilitygrantspreview](https://docs.crosmos.dev/api-reference/visibility/post-apiv1orgs-visibilitygrantspreview.md)
- [Delete apiv1orgs visibilitygrants](https://docs.crosmos.dev/api-reference/visibility/delete-apiv1orgs-visibilitygrants.md)
- [Get apiv1orgs visibilitypreview](https://docs.crosmos.dev/api-reference/visibility/get-apiv1orgs-visibilitypreview.md)
- [Patch apiv1orgs visibilitysettings](https://docs.crosmos.dev/api-reference/visibility/patch-apiv1orgs-visibilitysettings.md)
- [List memory spaces in active org](https://docs.crosmos.dev/api-reference/spaces/list-memory-spaces-in-active-org.md): Pass ?name= to resolve a space by its name (returns 0 or 1 since names are unique per org).
- [Create memory space](https://docs.crosmos.dev/api-reference/spaces/create-memory-space.md)
- [Get memory space](https://docs.crosmos.dev/api-reference/spaces/get-memory-space.md)
- [Delete memory space (owner/admin only)](https://docs.crosmos.dev/api-reference/spaces/delete-memory-space-owneradmin-only.md)
- [Get per-space usage](https://docs.crosmos.dev/api-reference/spaces/get-per-space-usage.md): Tokens ingested and search queries for a single space over a date range (defaults to the current calendar month). Use this to attribute usage to one end-user when you map one space per end-user.
- [Get analytics for one active space](https://docs.crosmos.dev/api-reference/analytics/get-analytics-for-one-active-space.md)
- [Get organization analytics](https://docs.crosmos.dev/api-reference/analytics/get-organization-analytics.md)
- [List Sources](https://docs.crosmos.dev/api-reference/sources/list-sources.md)
- [Ingest Sources](https://docs.crosmos.dev/api-reference/sources/ingest-sources.md): Enqueue a batch of sources for asynchronous ingestion. Fire-and-forget: returns 202 with a job_id you can poll via GET /jobs/{job_id}.
- [Get Source](https://docs.crosmos.dev/api-reference/sources/get-source.md)
- [Delete Source](https://docs.crosmos.dev/api-reference/sources/delete-source.md)
- [Update Source Visibility](https://docs.crosmos.dev/api-reference/sources/update-source-visibility.md)
- [List memories](https://docs.crosmos.dev/api-reference/memories/list-memories.md)
- [Get memory](https://docs.crosmos.dev/api-reference/memories/get-memory.md)
- [Forget memory](https://docs.crosmos.dev/api-reference/memories/forget-memory.md)
- [List entities](https://docs.crosmos.dev/api-reference/entities/list-entities.md)
- [Get entity](https://docs.crosmos.dev/api-reference/entities/get-entity.md)
- [Get graph viewport](https://docs.crosmos.dev/api-reference/graph/get-graph-viewport.md)
- [Get graph stats](https://docs.crosmos.dev/api-reference/graph/get-graph-stats.md)
- [Search Memories](https://docs.crosmos.dev/api-reference/search/search-memories.md): Search for relevant memories within a memory space using hybrid retrieval (semantic + keyword + graph + temporal), RRF fusion, cross-encoder reranking, and recency/temporal boosting.
- [Ingest Conversation](https://docs.crosmos.dev/api-reference/conversations/ingest-conversation.md): Ingest a multi-turn conversation. The conversation is stored as a single source and segmented at ingestion into windows of 4 turns; each window is extracted independently with the prior window as lookback context for pronoun resolution.
- [Get Job](https://docs.crosmos.dev/api-reference/jobs/get-job.md)
- [Get org usage](https://docs.crosmos.dev/api-reference/usage/get-org-usage.md)
- [List billing plans](https://docs.crosmos.dev/api-reference/billing/list-billing-plans.md)
- [Get subscription summary](https://docs.crosmos.dev/api-reference/billing/get-subscription-summary.md)
- [Create Polar checkout session](https://docs.crosmos.dev/api-reference/billing/create-polar-checkout-session.md)
- [Create Polar customer portal session](https://docs.crosmos.dev/api-reference/billing/create-polar-customer-portal-session.md)
- [Cancel subscription at period end](https://docs.crosmos.dev/api-reference/billing/cancel-subscription-at-period-end.md)
- [List org payment history](https://docs.crosmos.dev/api-reference/billing/list-org-payment-history.md): Paginated Polar order history for the active org, newest first. Amounts are in minor units (cents) of the order currency. An org that has never paid returns an empty list.
- [Get invoice URL for a payment](https://docs.crosmos.dev/api-reference/billing/get-invoice-url-for-a-payment.md): Returns a URL to the order's invoice PDF. Polar generates invoices lazily: if one does not exist yet this triggers generation and responds 202, and the client should retry shortly.
- [Receive Polar webhook](https://docs.crosmos.dev/api-reference/webhooks/receive-polar-webhook.md)
- [OAuth 2.1 authorization server metadata](https://docs.crosmos.dev/api-reference/oauth-server/oauth-21-authorization-server-metadata.md)
- [Dynamic client registration](https://docs.crosmos.dev/api-reference/oauth-server/dynamic-client-registration.md)
- [Lookup OAuth client](https://docs.crosmos.dev/api-reference/oauth-server/lookup-oauth-client.md)
- [AGENTS](https://docs.crosmos.dev/AGENTS.md)

## OpenAPI Specs

- [openapi](https://api.crosmos.dev/openapi.json)

## Optional

- [Console](https://console.crosmos.dev)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.