Deprecation
Cxense Search - /api/search - HTTP API has been replaced by /document/search and is no longer available for general use.
Introduction
This page provides general information about the Cxense Search API, along with additional references to get you started exploring the platform.
Contents
Demo Environment
The examples throughout the documentation uses the demo environment hosted at http://sandbox.cxsearch.cxense.com/. This service is externally accessible and you are welcome to try the examples described in the API (just note that others might be doing the same thing so your results may vary).
The data on this environment is a Unknown Attachment of the the BIRT sample database located at http://www.eclipse.org/birt/phoenix/db/
API Protocol
Cxense Search is accessed via a REST style API which supports standard options such as compression and negotiated media types (JSON and XML).
All API requests must be UTF-8 encoded.
We do not support URLs longer than 3500 characters.
Getting Started Guide
If you are new to the platform, we recommend you start with our Getting Started guide. The objective of this guide is to provide you with a quick introduction to the Cxense Search platform so you can start developing your search applications, as well as provide you with pointers to other articles where you can obtain more in-depth information about each of these features.
You can access this guide at Cxense Search - Getting Started.
For additional documentation, check the list of child pages available below, which focus on different aspects of the Cxense Search platform.