# SkimmerDB Docs

> SkimmerDB is a hosted database for apps and AI agents on object storage: a namespace per user, agent or task; exact and regex search with metadata filters; vector and hybrid search; SQL analytics over the same documents; bulk import; a REST API (https://api.skimmerdb.com/v1) with typed Python and TypeScript clients, and a remote MCP server with typed tool results (https://api.skimmerdb.com/mcp).

Each page is also Markdown: add .md to its URL (the introduction is /index.md). The OpenAPI document: https://api.skimmerdb.com/openapi.json. An agent skill for Claude Code and Codex: https://skimmerdb.com/skills/skimmerdb/SKILL.md.

## Get started

- [Introduction](https://docs.skimmerdb.com/index.md): SkimmerDB is a hosted database for apps and AI agents: exact and regex search, vectors and SQL over documents kept in object storage.
- [Quickstart](https://docs.skimmerdb.com/quickstart.md): Sign up, write documents, then search, filter, count, query with SQL and search by vector.
- [Concepts](https://docs.skimmerdb.com/concepts.md): Tenants, keys and scopes, namespaces, documents, durability, and what each query reports about its cost.
- [Python and TypeScript](https://docs.skimmerdb.com/sdks.md): The official clients: install, connect, write, search, count, SQL, errors and retries, and every API operation by its operationId.
- [Connect an agent (MCP)](https://docs.skimmerdb.com/mcp.md): SkimmerDB's remote MCP server for Claude, ChatGPT, Codex, Cursor and other agents, with OAuth or an API key.
- [Agent skill](https://docs.skimmerdb.com/agent-skill.md): A SKILL.md that teaches Claude Code, Codex and claude.ai how to model data in SkimmerDB and use it well.

## Guides

- [Data model](https://docs.skimmerdb.com/guides/data-model.md): How SkimmerDB stores what you write, and how to shape namespaces, ids and metadata so search, filters, vectors and SQL stay fast and cheap.
- [Writing documents](https://docs.skimmerdb.com/guides/writing.md): Put, update and delete documents, in batches, with the durability, visibility and retry rules that apply to every write.
- [Search and filters](https://docs.skimmerdb.com/guides/search.md): Exact text and regex search over documents, narrowed by metadata filters, with cursors, exact counts and estimates.
- [Vector and hybrid search](https://docs.skimmerdb.com/guides/vectors.md): Store embeddings with your documents and find the nearest, alone or narrowed by a text match and metadata filters.
- [Embeddings](https://docs.skimmerdb.com/guides/embeddings.md): Have SkimmerDB embed your documents' text and semantic searches, with your own OpenAI, Voyage, Gemini or Cohere key, or hosted at cost.
- [Analytics with SQL](https://docs.skimmerdb.com/guides/analytics.md): Every namespace is also a column store. Group, count and aggregate your documents with SQL, combined with exact text and regex matches.
- [Importing files](https://docs.skimmerdb.com/guides/import.md): Load CSV, NDJSON or Parquet into a namespace in one request, parsed straight into typed columns, every row visible together.
- [Agent memory](https://docs.skimmerdb.com/guides/agent-memory.md): A recipe for long-term memory per user or agent - what to store, how to recall it with text, filters and vectors, and how to scope and forget it.
- [Keys, scopes and tenants](https://docs.skimmerdb.com/guides/keys.md): Who can do what - API keys with scopes, keys limited to some namespaces, caps and rates, tenants, and the keys MCP connections get.
- [Performance and cost](https://docs.skimmerdb.com/guides/performance.md): What every answer tells you about its cost, and the habits that keep queries fast and object-storage reads few.

## Reference

- [SQL](https://docs.skimmerdb.com/reference/sql.md): The SQL dialect SkimmerDB runs over a namespace's documents: statements, types, NULLs, operators, functions, text predicates, answers and limits.
- [Filters](https://docs.skimmerdb.com/reference/filters.md): The filter syntax for search, listing, counts and vector queries: equality, one of, not equal, numeric ranges, and how values compare.
- [MCP tools](https://docs.skimmerdb.com/reference/mcp-tools.md): Every tool on SkimmerDB's MCP server, its arguments, what it answers and which connections see it.
- [Errors](https://docs.skimmerdb.com/reference/errors.md): Every error SkimmerDB answers with: its shape, each status and code, what to do, and which requests are safe to retry.
- [Limits and plans](https://docs.skimmerdb.com/reference/limits.md): What each plan includes and costs, its rates and quotas, and the limits on documents, writes, queries and imports.
- [Durability](https://docs.skimmerdb.com/reference/durability.md): When a write is safe, when it becomes visible, and what you see when a server or object storage fails.

## API reference

- [Overview](https://docs.skimmerdb.com/api.md): base URL, authentication, errors, rate limits, pagination.
- [Accounts](https://docs.skimmerdb.com/api/accounts): Sign up, log in, who you are. POST /v1/signup, POST /v1/login, POST /v1/email/verify, POST /v1/email/verify/resend, POST /v1/password/forgot, POST /v1/password/reset, GET /v1/me
- [Keys](https://docs.skimmerdb.com/api/keys): API keys: scopes, namespaces, caps. GET /v1/keys, POST /v1/keys, DELETE /v1/keys/{id}, PUT /v1/keys/{id}/limits
- [Tenants](https://docs.skimmerdb.com/api/tenants): A tenant owns namespaces, keys, usage and a bill. GET /v1/tenants, POST /v1/tenants, DELETE /v1/tenants/{id}
- [Namespaces](https://docs.skimmerdb.com/api/namespaces): Named sets of documents, one per user, task or project. POST /v1/namespaces, GET /v1/namespaces, PATCH /v1/namespaces/{name}, GET /v1/namespaces/{name}, DELETE /v1/namespaces/{name}
- [Documents](https://docs.skimmerdb.com/api/documents): Write, update, delete, read, import. POST /v1/namespaces/{name}/docs, PATCH /v1/namespaces/{name}/docs, POST /v1/namespaces/{name}/delete, GET /v1/namespaces/{name}/docs/{id}, POST /v1/namespaces/{name}/import
- [Search](https://docs.skimmerdb.com/api/search): Text, regex, filters, vectors, counts. POST /v1/namespaces/{name}/search, GET /v1/namespaces/{name}/search, POST /v1/namespaces/{name}/count, GET /v1/namespaces/{name}/count, POST /v1/namespaces/{name}/warm
- [Embeddings](https://docs.skimmerdb.com/api/embeddings): Documents' text and semantic searches embedded with your own OpenAI, Voyage, Gemini or Cohere key, or hosted by SkimmerDB at cost. GET /v1/embedding-keys, PUT /v1/embedding-keys/{provider}, DELETE /v1/embedding-keys/{provider}
- [SQL (beta)](https://docs.skimmerdb.com/api/sql): SQL over the documents' metadata. POST /v1/namespaces/{name}/sql
- [Usage](https://docs.skimmerdb.com/api/usage): What you used and what it costs. GET /v1/usage
- [Billing](https://docs.skimmerdb.com/api/billing): Plans and Stripe. GET /v1/billing, POST /v1/billing/checkout, POST /v1/billing/portal
- [Linked namespaces](https://docs.skimmerdb.com/api/linked-namespaces): Indexes linked by reference. GET /v1/namespaces/{name}/sidecars, GET /v1/namespaces/{name}/sidecars/{seg}/{file}
- [MCP](https://docs.skimmerdb.com/api/mcp): For AI agents. POST /mcp, GET /.well-known/oauth-protected-resource
- [Meta](https://docs.skimmerdb.com/api/meta): Health and this document. GET /healthz, GET /openapi.json