Search Index Export API
Beyond the search engines with dedicated integrations (Algolia, Elasticsearch, SearchWP, Relevanssi, Ivory Search), WP Super Docs exposes a REST endpoint that returns every published doc as JSON. This is for pushing your docs into a search service that doesn’t have a built-in integration, like Meilisearch or Typesense, or for any other custom use of your docs content.
The endpoint#
GET /wp-json/wpsd/v1/search-index
You can find your site’s exact URL, with a copy button, under WP Super Docs → Settings → Integrations, in the Search Index Export card.

Turning it on and controlling access#
Click Configure to expand the settings:
- Enabled: the endpoint responds only when this is turned on. Turned on by default.
- Public access: if turned on, anyone can call the endpoint with no authentication. Only enable this if your docs are already fully public, since it makes your entire docs content freely downloadable by anyone who finds the URL.
- API key: if public access is off, requests need this key, either as
?api_key=...or anAuthorization: Bearer ...header. Click Generate for a random 32-character key. If you leave this blank (and public access is off), the endpoint instead requires a logged-in WordPress session, useful for testing from the admin but not for external services. - Max content length: how many characters of each doc’s plain-text content to include, 5000 by default. Algolia’s free plan caps records at 10 KB, so this exists to keep individual records from exceeding that kind of limit. Set to 0 for unlimited.
Query parameters#
| Parameter | Effect |
|---|---|
?page=N | Page number, default 1 |
?per_page=N | Records per page, up to 500, default 100 |
?product=slug | Only return docs from one product |
?fields=id,title,url | Return only the listed fields instead of the full record |
What’s left out#
Internal-only docs and docs in a Draft version are never included, whatever the access settings, since an external search service can’t check who’s logged in. See Making Docs, Categories, or Products Internal-Only and Draft Versions.
What each record contains#
Every record includes an id (the WordPress post ID, also duplicated as objectID for direct Algolia compatibility), title, plain-text excerpt and content (HTML and shortcodes stripped), URL, slug, product name/slug/ID, an array of categories, an order value, timestamps, and a featured image URL if one is set. If you need additional fields, the wpsd_search_index_record PHP filter lets a developer append custom data to each record.
Response headers#
| Header | Meaning |
|---|---|
X-WP-Total | Total number of docs matching the request |
X-WP-TotalPages | Total number of pages at the current per_page |
X-WPSD-ID-Field | Always id, telling you which field to treat as the record’s unique identifier |
Was this helpful?
Thanks for your feedback!
✓ Feedback received. Thank you!