The OpenSearch API is a RESTful web API. The topics in the API reference describe the features, request methods, and parameters of the API operations. The OpenSearch API contains the operations that are related to applications, data uploads, and searches.
Each request to call an API operation must contain a URL request string and request headers. Otherwise, the request is invalid.
Terms
Acronym | Full name |
| Description |
app | application |
| An application serves as a complete search service. |
Error codes
Related topic | Description |
Describes error codes. |
Common call methods
Related topic | Description |
Describes the authentication and signature calculation mechanism of OpenSearch. |
API operations related to applications
Related topic | Description |
Create, update, and delete documents. | |
Search for documents. | |
Query drop-down suggestions. | |
You can call an API operation to push collected data to a specific application. |