Developer Features

Introduction

This page is for developers who are building, integrating, or extending SearchBlox in their applications. Whether you're embedding a search box into a website, connecting SearchBlox to your existing data systems, or building a fully custom search experience using the API, this page covers the tools available to you.

What Can Developers Do?
As a developer, you can:

  • Connect SearchBlox to your application using the REST API
  • Embed a working search interface into any website or app in minutes
  • Index content from 329+ data sources including databases, cloud storage, and SaaS tools
  • Build custom search UIs using JSON responses
  • Add AI-powered features like conversational search, smart suggestions, and direct answers
  • Secure search results based on user identity and permissions
  • Track and debug API requests using custom headers and logs

Developer Features

APIs
What is a REST API? A REST API is a standard way for software systems to communicate over the web. It lets your application send requests to SearchBlox and receive structured data back — without needing to understand SearchBlox's internal workings.

FeatureWhat it does
REST-APIThe core API for SearchBlox. Use it to add or remove content, create and configure data collections, manage featured results, run searches, and access features like AutoSuggest, Top Queries, and Related Queries — all programmatically from any platform or language.
Custom Header - X-Correlation-IDAttach a unique tracking ID to any REST API request. This ID is recorded in the query log (logs/query.log), making it easier to trace, debug, and audit specific searches in your system.
Content APIRetrieve the actual content and URL of a document based on a search query. Useful for building custom result displays or extracting indexed content for other purposes.

Search Integration

FeatureWhat it does
Search IntegrationAdd search to any website or application in two ways: (1) drop in a pre-built search results plugin with minimal code, or (2) embed custom search code directly into your app for full control over the look and behavior.
Voice SearchAllow users to speak their search query instead of typing. Powered by Google Speech-to-Text technology. Works in any browser that supports the Web Speech API.

Data Ingestion & Indexing

What is data ingestion? This is the process of pulling content from your various data sources into SearchBlox so it can be searched. SearchBlox can read from websites, databases, file systems, cloud storage, and more.

FeatureWhat it does
Data Ingestion (329+ Sources)Connect to over 329 data sources out of the box — including websites, databases (MySQL, PostgreSQL, SQL Server, Oracle), cloud storage (S3, Azure Blob, Google Drive), and SaaS tools (SharePoint, Salesforce, Zendesk, and more).
Single Page Application (SPA) CrawlingIndex content from modern JavaScript-heavy websites (React, Angular, Vue) that don't return full HTML on the first page load. SearchBlox's crawler handles these correctly.
AEM IntegrationIntegrate SearchBlox with Adobe Experience Manager (AEM) to index AEM repository content. Supports continuous background indexing via AEM agents, on-demand indexing via API, and embedding search directly into AEM pages.

Security

FeatureWhat it does
Data EncryptionEncrypt sensitive content at the collection, document, or individual field level so only authorized users can access it through search results.
Secure Search IntegrationRestrict search results based on who is logged in. Integrates with LDAP/Active Directory or Okta so users only see content they are permitted to access.
SAML SSO for Admin ConsoleEnable Single Sign-On for the SearchBlox Admin Console using SAML. Allows administrators to log in with their existing company credentials instead of a separate SearchBlox password.

AI-Powered Features (SearchAI)

FeatureWhat it does
PreText (NLP)Natural Language Processing that helps SearchBlox understand the intent behind a query — not just the exact words typed. For example, a search for "how do I reset my password" returns help articles, not just pages containing those exact words.
SmartSuggestAI-powered autocomplete that suggests relevant search queries as the user types — based on content and past search patterns, not just simple text matching.
AnswersExtracts and displays a direct answer from indexed content at the top of search results — so users get the answer immediately without clicking through to a document.
PersonalizationAdjusts search results based on each user's past behavior and preferences, so frequent users see more relevant results over time.
ChatBot IntegrationEmbed a conversational search interface into your application. Users can ask questions in natural language and receive guided answers pulled from your indexed content.

Quick Reference: Common Developer Tasks

I Want To...Feature to Use
Run a search query from my appREST API
Add a document to the search indexREST API
Embed search into my websiteSearch Integration
Connect to a database or cloud storageData Ingestion (329+ Sources)
Restrict results by user permissionsSecure Search Integration
Add autocomplete to my search boxSmartSuggest
Debug a specific API requestCustom Header X-Correlation-ID
Index a React or Angular websiteSingle Page Application (SPA) Crawling
Add a chatbot to my appChatBot Integration
Encrypt sensitive search contentData Encryption