`php\n<\/code><\/pre>\n\ndefine( 'ASKIVA_API_BASE', 'https:\/\/your-askiva-api.example.com\/api\/v1' );\n `<\/p>\n\n
Option 2: filter hook<\/p>\n\n
`php\n<\/code><\/pre>\n\nadd_filter( 'askiva_api_base', function () {\n return 'https:\/\/your-askiva-api.example.com\/api\/v1';\n} );\n `<\/p>\n\n
If neither is set, the plugin uses https:\/\/askiva-bk.postyoulike.com\/api\/v1<\/code> by default.<\/p>\n\nUsage<\/h3>\n\nSearch shortcode<\/h3>\n\n`\n<\/code><\/pre>\n\n[askiva_search]\n `<\/p>\n\n
Place on any page, post, or widget area. Visitors search inline; the AI answer streams in and results appear below the form.<\/p>\n\n
Common setup:<\/p>\n\n
\n- Create a page (e.g.
\/search\/<\/code>) with [askiva_search show_results=\"1\"]<\/code><\/li>\nFor a header or sidebar button that redirects to your search page, use the popup shortcode:<\/p>\n\n
[askiva_search_popup results_url=\"\/search\/\" trigger_text=\"Search\"]<\/code><\/p><\/li>\nOptionally set a global results URL for the popup shortcode:<\/p>\n\n
php\nadd_filter( 'askiva_search_results_url', function () {\nreturn site_url( '\/search\/' );\n} );<\/code><\/p><\/li>\n<\/ol>\n\nNote: [askiva_search show_results=\"0\"]<\/code> hides pre-loaded results on page load, but search still runs inline on that page via JavaScript. Use the popup shortcode to redirect visitors to a separate search page.<\/p>\n\nShortcode attributes:<\/p>\n\n\n\n\n Attribute\n Type\n Default\n Description\n\n\n\n\n placeholder<\/code>\n string\n Search\u2026\n Input placeholder\n\n\n button_text<\/code>\n string\n Search\n Button label (legacy)\n\n\n site_id<\/code>\n string\n (from settings)<\/em>\n Override site ID; saved settings always win when set\n\n\n type<\/code>\n string\n (empty)<\/em>\n Optional content type filter sent to API\n\n\n results_url<\/code>\n string\n (auto)<\/em>\n Full URL or path for search results page\n\n\n results_page_id<\/code>\n int\n -\n WordPress page ID for results (alternative to results_url<\/code>)\n\n\n show_results<\/code>\n auto<\/code> | 0<\/code> | 1<\/code>\n auto\n When to show results block (auto<\/code> = when ?q=<\/code> is present)\n\n\n results_limit<\/code>\n int\n (from settings)<\/em>\n Results per page (1\u2013100)\n\n\n view_all_limit<\/code>\n int\n 50\n Max results when \u201cview all\u201d is used\n\n\n ajax<\/code>\n 0<\/code> | 1<\/code>\n 0\n Legacy flag; JS still handles live search. Affects pagination scroll behavior\n\n\n live<\/code>\n bool\n false\n Search while typing (debounced)\n\n\n min_chars<\/code>\n int\n 2\n Minimum characters before search runs\n\n\n debug<\/code>\n 0<\/code> | 1<\/code>\n 0\n Pass debug flag to search API (admin troubleshooting)\n\n\n limit<\/code>\n int\n 10\n Legacy AJAX limit\n\n\n\n\nURL query parameters:<\/p>\n\n\n\n\n Parameter\n Default name\n Purpose\n\n\n\n\n Search query\n q<\/code>\n Search term (askiva_q<\/code> legacy alias still supported)\n\n\n Page\n askiva_page<\/code>\n Pagination\n\n\n View all\n view<\/code>\n Use view=all<\/code> for expanded result limit\n\n\n\n\nChange the query parameter name:<\/p>\n\n
`php\n<\/code><\/pre>\n\nadd_filter( 'askiva_search_query_param', function () {\n return 'q';\n} );\n `<\/p>\n\n
Popup search shortcode<\/h3>\n\n
Opens a modal search box and redirects to your results page on submit:<\/p>\n\n
`\n<\/code><\/pre>\n\n[askiva_search_popup results_url=\"\/search\/\" trigger_text=\"Search\"]\n `<\/p>\n\n\n\n\n Attribute\n Default\n Description\n\n\n\n\n trigger_text<\/code>\n Search\n Button that opens the popup\n\n\n placeholder<\/code>\n Search\u2026\n Input placeholder\n\n\n close_text<\/code>\n Close\n Close button label\n\n\n results_url<\/code>\n (auto)<\/em>\n Where to send the user after search\n\n\n results_page_id<\/code>\n -\n Page ID alternative to results_url<\/code>\n\n\n min_chars<\/code>\n 2\n Minimum query length\n\n\n\n\nFrontend search behavior<\/h3>\n\n
When a visitor searches:<\/p>\n\n
\n- AI answer<\/strong>: streamed via Server-Sent Events (
\/search\/stream<\/code>), rendered as GFM Markdown (bold, italics, bullet\/numbered lists) with DOMPurify sanitization<\/li>\n- Search results<\/strong>: fetched via AJAX proxy (
\/search\/<\/code>), with thumbnails and excerpts<\/li>\n- Did you mean<\/strong>: shown when the API returns a
did_you_mean<\/code> suggestion<\/li>\n- Source links<\/strong>:
[Source N]<\/code> markers in the AI answer link to matching result URLs<\/li>\n<\/ol>\n\nBundled assets (no external CDN): marked.min.js<\/code> (v15.0.12), purify.min.js<\/code>, search.js<\/code>, search.css<\/code>.<\/p>\n\nTheme template overrides<\/h3>\n\n
Copy templates into your theme to customize markup:<\/p>\n\n
`\n<\/code><\/pre>\n\nwp-content\/themes\/your-theme\/centous-ai-search-with-askiva\/\n search.php\n search-results.php\n search-result-item.php\n search-popup.php\n `<\/p>\n\n
Dashboard<\/h3>\n\n
Centous Search \u2192 Dashboard shows (when connected):<\/p>\n\n
\n- Connected site \/ domain<\/li>\n
- Indexed pages<\/li>\n
- Searches this month<\/li>\n
- AI answers generated<\/li>\n<\/ul>\n\n
Statistics are fetched from GET \/wp\/stats<\/code> and cached for performance.<\/p>\n\nSync<\/h3>\n\n
Centous Search \u2192 Sync:<\/p>\n\n
\n- Optionally enable Delete all data and start fresh sync<\/strong> for a full re-index<\/li>\n
- Click Start Sync<\/strong> to index published content in batches<\/li>\n
- Monitor progress and logs in the sync panel<\/li>\n<\/ol>\n\n
Sync uses POST \/wp\/documents\/<\/code> in batches sized by Content Items per Index Cycle<\/strong>. Long-running sync requests extend PHP time limits automatically.<\/p>\n\nNote: Closing the browser may pause progress; resume from the Sync page.<\/p>\n\n
WordPress REST API (plugin)<\/h3>\n\n
Registered under askiva\/v1<\/code> for remote\/automated sync control:<\/p>\n\n\n\n\n Route\n Method\n Description\n\n\n\n\n \/wp-json\/askiva\/v1\/remote-sync<\/code>\n POST\n Start or resume sync (returns immediately; use \/sync\/tick<\/code> to advance)\n\n\n \/wp-json\/askiva\/v1\/sync\/status<\/code>\n GET\n Current sync status\n\n\n \/wp-json\/askiva\/v1\/sync\/start<\/code>\n POST\n Start sync (fresh_start<\/code> optional)\n\n\n \/wp-json\/askiva\/v1\/sync\/pause<\/code>\n POST\n Pause sync\n\n\n \/wp-json\/askiva\/v1\/sync\/resume<\/code>\n POST\n Resume sync\n\n\n \/wp-json\/askiva\/v1\/sync\/restart<\/code>\n POST\n Restart sync\n\n\n \/wp-json\/askiva\/v1\/sync\/tick<\/code>\n POST\n Process one sync tick\n\n\n\n\nAuthenticate with the same credentials saved in Centous Search \u2192 Settings<\/strong>:<\/p>\n\n\n- Site identifier<\/strong>: send as
site_id<\/code>, site_identifier<\/code>, or api_site_id<\/code> (JSON body or query), or header X-Askiva-Site-Id<\/code> \/ X-Askiva-Site-Identifier<\/code><\/li>\n- Site key<\/strong>: send as
site_key<\/code> or api_key<\/code> (JSON body or query), or header X-Askiva-Key<\/code><\/li>\n<\/ul>\n\nBoth the string site identifier (e.g. sdgicity-kH33Isf1<\/code>) and numeric api_site_id<\/code> from verify are accepted when they match saved settings.<\/p>\n\nAskiva backend API<\/h3>\n\n
All paths are relative to your configured API base (e.g. https:\/\/api.example.com\/api\/v1<\/code>).<\/p>\n\nConnection and status<\/p>\n\n\n\n\n Method\n Endpoint\n Description\n\n\n\n\n POST\n \/wp\/verify<\/code>\n Validate Site ID + Site Key\n\n\n POST\n \/wp\/connect<\/code>\n Legacy connect\n\n\n GET\n \/wp\/status<\/code>\n Connection test (X-Askiva-Key<\/code> header)\n\n\n GET\n \/wp\/stats<\/code>\n Site statistics\n\n\n\n\nDocuments and indexing<\/p>\n\n\n\n\n Method\n Endpoint\n Description\n\n\n\n\n POST\n \/wp\/documents\/<\/code>\n Index a batch of documents\n\n\n GET\n \/wp\/documents\/batch\/{id}<\/code>\n Batch status\n\n\n DELETE\n \/wp\/documents\/all<\/code>\n Delete all indexed documents (site_id<\/code> + api_key<\/code> in JSON body, X-Askiva-Key<\/code> header)\n\n\n\n\nSearch (frontend)<\/p>\n\n\n\n\n Method\n Endpoint\n Description\n\n\n\n\n POST\n \/search\/<\/code>\n Search results + AI answer metadata\n\n\n POST\n \/search\/stream<\/code>\n Streamed AI answer (SSE)\n\n\n\n\nSearch requests send site_id<\/code>, api_key<\/code>, query<\/code>, limit<\/code>, and page<\/code> in the JSON body, plus X-Askiva-Key<\/code> header.<\/p>\n\nDeveloper filters<\/h3>\n\n`php\n<\/code><\/pre>\n\n\/\/ API base URL\nadd_filter( 'askiva_api_base', $callback );<\/p>\n\n
\/\/ Default search results page URL\nadd_filter( 'askiva_search_results_url', $callback );<\/p>\n\n
\/\/ URL query parameter name (default: q)\nadd_filter( 'askiva_search_query_param', $callback );<\/p>\n\n
\/\/ Include API trace\/debug in search payload (default: true)\nadd_filter( 'askiva_search_include_trace', $callback );<\/p>\n\n
\/\/ Template variables passed to PHP templates\nadd_filter( 'askiva_template_vars', $callback, 10, 2 );\n <h3>Requirements<\/h3>\n* WordPress 5.8+\n* PHP 7.4+\n* Valid Askiva account (Site Identifier and API Key from the [Askiva dashboard](https:\/\/askiva-ai-frontend.vercel.app\/))\n* Outbound HTTPS to the Askiva API host\n* Published content to index (drafts are skipped)<h3>Features<\/h3>\n* Secure admin AJAX with nonces and<\/code>manage_optionschecks\n* Site ID + Site Key connection with verify endpoint\n* Batch content sync with pause\/resume\/restart\n* Real-time sync status and error logging\n* Streaming AI answers with GFM Markdown rendering\n* \u201cDid you mean\u201d typo suggestions from API\n* List and grid result layouts with configurable thumbnails\n* Search popup shortcode for header\/navigation use\n* Server-rendered and AJAX search modes\n* Theme template overrides\n* WordPress REST sync endpoints for automation\n* Cached dashboard statistics\n* First-run redirect to settings\n* Clean uninstall support<h3>Troubleshooting<\/h3><h3>Connection issues<\/h3>\n1. Confirm **Site ID** and **Site Key** match the **Site Identifier** and **API Key** on your Askiva site detail page\n2. If you use a custom API host, verify<\/code>ASKIVA_API_BASE(or the<\/code>askiva_api_basefilter) includes<\/code>\/api\/v1and points to the correct server\n3. Use **Test Connection** on the Settings page\n4. Check **Centous Search \u2192 Logs** for API error details<h3>Search issues<\/h3>\n1. Ensure the site is connected and content has been synced\n2. Confirm the shortcode page loads<\/code>search.js(no JavaScript console errors)\n3. In browser DevTools \u2192 Network, inspect<\/code>askiva_public_searchand<\/code>askiva_public_search_streamAJAX calls\n4. Enable shortcode<\/code>debug=\"1\"` for API trace data when diagnosing \u201cDid you mean\u201d<\/p>\n\nSync issues<\/h3>\n\n