Integrations
Keep your search client and your site. DocSlurp replaces the index behind them.
Find the way to connect DocSlurp to your app, site or agent, and see what ships today and what's planned. Start with a native interface, or use an adapter to keep a search UI you already have. To see search working first, try the live playground.
Keep your search client
Algolia
PfPagefind
Meilisearch
Typesense
Pricing FAQ
Annual plans are billed up front.
Refunds are prorated for the unused months.
Seats can be added at any time.
8
Your workspace
Ship it on your site
Astro
Next.js
WordPress
</>Plain HTML
On this page
Native interfaces
Upload documents, wait for processing and retrieve cited passages. Every interface reads and writes the same workspaces, so you can mix them: upload from the CLI, search from your app.
- HTTP API
Upload, process and retrieve from any language. Start here when you want direct control.
/openapi.jsonAvailable - JavaScript / TypeScript
Typed ingestion, cited search and run progress for Node.js applications.
@docslurp/sdkAvailable - MCP server
Let agents and coding tools search your workspaces and cite the page.
/v1/mcpAvailable - Command line
Upload files, watch processing and retrieve evidence from your terminal or CI.
@docslurp/cliAvailable - OpenAI-compatible chat
Point any OpenAI SDK at a workspace and get cited answers, with streaming and usage.
/v1/chat/completionsAvailable
Integration subpaths and live progress methods require SDK and CLI v0.2.0 or newer. Check availability.
Search adapters
Already calling Algolia, Pagefind, Meilisearch or Typesense? Replace the client constructor and keep your search calls and result rendering. DocSlurp handles ingestion and retrieval, and every hit carries its source page.
- const client = algoliasearch(appId, apiKey)
+ const client = createDocSlurpAlgoliaClient({ apiUrl, clientKey })
await client.search({ requests }) // unchanged- Algolia
Keep conventional v4/v5 search calls and connect your existing search interface.
@docslurp/sdk/search-adaptersDeveloper preview - Pagefind
Keep search(term), result metadata and the lazy data() interface in custom renderers.
@docslurp/contrib-search-compat/pagefindDeveloper preview - Meilisearch
Preserve index(id).search() and familiar hit and pagination envelopes.
@docslurp/contrib-search-compat/meilisearchDeveloper preview - Typesense
Use collection search and ordered multi-search with nested document hits.
@docslurp/contrib-search-compat/typesenseDeveloper preview
Adapters cover a documented subset of each API. Filters, provider administration and the stock Pagefind UI need a compatibility review; each guide lists what is supported.
Websites and CMS
Put cited search on a site you already run. Astro and WordPress have packages; Next.js and plain HTML use the framework-free widget. Dedicated CMS connectors are planned, and the HTTP API and widget work with any of them today.
Frameworks and plugins
- Astro
A native Astro component with a small framework-free browser widget.
@docslurp/contrib-astroDeveloper preview - WordPress
Install a shortcode with a server-side proxy that keeps the server key private.
DocSlurp Search pluginDeveloper preview - Next.js
Register a custom element from a client component, with SSR-safe imports.
@docslurp/sdk/widgetRecipe - HTML / other CMS
A custom element for sites with their own asset pipeline and templates.
@docslurp/sdk/widgetRecipe
CMS platforms
- Shopify
Theme app extension, published content sync and public search.
Integration planPlanned - Wix
Site search with a Velo backend and published-content ingestion.
Integration planPlanned - Squarespace
An embed recipe with public source URLs and content refresh.
Integration planPlanned - Joomla
A module/plugin with article sync and explicit access rules.
Integration planPlanned - Webflow
CMS publishing hooks, canonical links and an embedded search UI.
Integration planPlanned - Drupal
A module for indexed content, permissions and a search block.
Integration planPlanned - Strapi
A headless CMS bridge with draft and publication boundaries.
Integration planPlanned
Documentation sites
- Docusaurus
Versioned docs, localized routes and a familiar search experience.
Integration planPlanned - Slate
Search generated API documentation without changing its reading flow.
Integration planPlanned
CMS priorities combine CMS adoption data with a headless target; this is a delivery roadmap, not a market-share ranking. Each connector must handle published content, updates, deletes and private-content permissions.
Other languages
JavaScript and TypeScript have a native SDK today. For any other language, call the HTTP API; it is plain JSON over HTTPS. The native clients below are planned and not published, so don't install a package by guessing its name.
| Language | Registry | Status | Links |
|---|---|---|---|
| JavaScript / TypeScript | npm | Available | @docslurp/sdk |
| Python | PyPI | Planned | SDK planPyPI signup |
| Rust | crates.io | Planned | SDK planGitHub signup |
| Go / Golang | Go modules | Planned | SDK planGitHub signup |
| Elixir | Hex | Planned | SDK planHex signup |
| .NET / C# | NuGet | Planned | SDK planMicrosoft signup |
| Java / Kotlin (JDK) | Maven Central | Planned | SDK planCentral account setup |
| Smalltalk | Metacello / source | Planned | SDK planGitHub signup |
| Modern C++ | CMake with Conan or vcpkg | Planned | SDK planGitHub signup |
| PHP | Packagist | Planned | SDK planPackagist signup |
| Ruby | RubyGems | Planned | SDK planRubyGems signup |
Registry links are for maintainers publishing a client; you don't need an account to call the API. crates.io uses GitHub login, NuGet uses Microsoft sign-in, and Go modules, Smalltalk and Conan or vcpkg recipes publish from source hosting. Java is shown with the OpenJDK mark; Oracle's Java logo is a separate trademark. Publishing notes.
Hand off to an agent
Each prompt tells a coding agent which guide to read, which contracts to keep and what to verify. Copy one into Claude Code, Codex or Cursor from the root of your project. Prompts use placeholders and never contain keys.
- HTTP API
Review agent instructions
- JavaScript / TypeScript
Review agent instructions
- MCP server
Review agent instructions
- Command line
Review agent instructions
- OpenAI-compatible chat
Review agent instructions
- Algolia
Review agent instructions
- Pagefind
Review agent instructions
- Meilisearch
Review agent instructions
- Typesense
Review agent instructions
- Astro
Review agent instructions
- WordPress
Review agent instructions
- Next.js
Review agent instructions
- HTML / other CMS
Review agent instructions
- Shopify
Review agent instructions
- Wix
Review agent instructions
- Squarespace
Review agent instructions
- Joomla
Review agent instructions
- Webflow
Review agent instructions
- Drupal
Review agent instructions
- Strapi
Review agent instructions
- Docusaurus
Review agent instructions
- Slate
Review agent instructions
Trademark notice
Product names, logos and brands on this page belong to their owners. They identify compatible products and interfaces only; DocSlurp is not affiliated with, endorsed by or sponsored by any of them.
Logo sources
- Official single-path marks via the Simple Icons directory (CC0-licensed code; trademark rights stay with the brands): TypeScript, MCP, Claude, Cursor, OpenCode, Algolia, Meilisearch, WordPress, Shopify, Wix, Squarespace, Joomla, Webflow, Drupal, Strapi, Astro, Next.js, HTML5, Docusaurus, Python, Rust, Go, Elixir, .NET, OpenJDK, C++, PHP, Ruby, npm, PyPI, NuGet, RubyGems, Packagist.
- Vendor-published official artwork: Typesense (official dark wordmark from typesense.org; no compact glyph is published), Hex (official hexpm project asset), OpenAI (2025 symbol via Wikimedia Commons, public domain).
- Our own marks, not third-party artwork: the HTTP
{}and CLI>_glyphs and the DocSlurp wordmark. - Text monograms where no official vector mark is available: Slate, Smalltalk, crates.io, Maven Central, Metacello, CMake, Conan and vcpkg, Pagefind (no vector logo found at time of writing; point us at one and we'll adopt it).
- Shown with the OpenJDK mark: Java / Kotlin. Oracle's Java coffee-cup logo is a separate trademark we don't reproduce.
- Hand-drawn close-to-official illustrations elsewhere in the docs: Claude Code, Codex, VS Code and the DocSlurp CLI marks (their official vectors aren't redistributable here; VS Code follows the official geometry).