Search our Blogs
Showing results for 
Search instead for 
Do you mean 

Getting Started with HP IDOL OnDemand

Please note that HP IDOL OnDemand is now HPE Haven OnDemand. The API endpoints have changed to Haven OnDemand. Please see the API documentation for more details.





This Getting Started post will get you flying with IDOL’s powerful analysis services such as text analysis, search capabilities, and format conversion – in 5 to 10 minutes.


Getting Started

First, you need access to the IDOL OnDemand APIs. To get access, you must register a developer account in order to obtain an API key. Use the API key to submit data analysis requests.


Sign up for an API key

Setting up an account is easy. Simply visit and click the Sign Up button. Sign up with your email and name, and follow the instructions.


After approval of registration and confirming your email by clicking the confirmation link in the Welcome email, you will have access to the Developer Home. You can retrieve your API Key via the Account link or find your API key in one of the Try pages at the top of the Quick Example UI for each API.




The Developer Homepage

From the Developer Home, you have access to the demo gallery, API documentation, and an online quick example ‘Try’ tab under each API page. Browse the demo gallery to see an Image Demo, Search Demo, and Expire, an app for social media reputation management. Each API Reference page also has an online quick example ‘Try’ tab where you can test specific API requests, see the response formats and generated request commands in cURL syntax.





API Format

A growing selection of APIs is available in IDOL OnDemand that can be accessed synchronously or asynchronously. The APIs are categorized into main groups according to function: Format Conversion, Search and Text Analysis.


Each API follows the following URI Resource syntax:{platform-version}/api/{synchronous-or-asynchronous}/{api-identifier}/{...



For example, to submit a ‘Dog’ keyword search request to the Query Text Index API, use the following URL:




Using the APIs

Once you've selected an API from the API list, you’ll be presented with an API page with several tabs. The ‘Overview’ tab provides you with a functional description of the API. The ‘Request’ tab details the request format including the URI Resource format and input parameters, and the Response tab details the Response format including the response data object details.


Finally, there is the ‘Try’ tab to see a quick example. Each ‘Try’ page has a UI with a quick example form that can be used to submit example requests and review the response data. The ‘Try’ tab also generates a cURL command for the submitted request at the bottom of the page.


Code Example: Find Similar API

The following example code sends a multipart/form-data POST request to the Find Similar API, using cURL from a Windows cmd shell.


C:\Users\user1>curl -X POST -H Content-Type:multipart/form-data; ^
More?  -F file=@C:\Users\user1\Documents\bigbang.txt ^
More? -F apikey=550e8400-e29b-41d4-a716-446655440000 ^



The file ‘bigbang.txt’ contains the text from a newspaper article about the scientific confirmation of the big bang theory, in the New York Times from March 18, 2014. The first paragraph of the newspaper article reads:


“Space Ripples Reveal Big Bang’s Smoking Gun CAMBRIDGE, Mass. — One night late in 1979, an itinerant young physicist named Alan Guth, with a new son and a year’s appointment at Stanford, stayed up late with his notebook and equations, venturing far beyond the world of known physics.”


The full article text can be accessed here: .


A successful response returns a 200 OK status code and the following JSON fragment of the response body:


"documents": [ {
"reference": " of physics",
"weight": 58.6,
"links": [
"index": "wiki_eng",
"title": "History of physics"
}, {




Learn more at

Social Media
About the Author
† The opinions expressed above are the personal opinions of the authors, not of HPE. By using this site, you accept the Terms of Use and Rules of Participation