Autosuggest API integration

The Autosuggest API improves your search functionality by providing topic or organization suggestions based on user input.

Results are delivered in JSON format.

Enter a term to receive suggested topics and organizations, along with metadata such as descriptions and web links. This API is especially valuable for creating better search experiences. For example, in our SCOUT query builder, users can input a topic and receive related topic suggestions to refine their complex queries.

These search queries can then be applied within the Panel API and Documents API to obtain relevant innovation insights. However, its use is optional—you may choose to create search queries manually if you prefer.

‍

Getting started 

Before integrating the Autosuggest API, you must authenticate and generate a token. You can test the API using the API Demo page, where you can also download a JavaScript demo app to test it directly in your browser.

‍

Make Requests

To interact with the API, you must send HTTP GET or POST requests to the API endpoint using the default content type. Every request needs a token.

• API Endpoint: https://api.mapegy.com
• Content-Type: application/x-www-form-urlencoded

There are two endpoints for autosuggestions:

• Autosuggest/Topics/?query=  Provides topic suggestions based on your input.
• Autosuggest/Organizations/?query= Provides organization name suggestions based on your input.

Required parameter for both endpoints is query. Enter a keyword to receive relevant suggestions.

Optional Parameters:

• limit: Restricts the number of suggestions, just enter a number from 1 to 10.
• include: Specifies which response fields to retrieve. List the desired response fields, separated by commas. To view all available fields, run a query without specifying this parameter.
• For organization autosuggestions, you can further filter results by organization type: Companies, Startups, Hospitals, Government, Groups, and Investees.

‍

Example: Access the Autosuggest API with a valid token

• Route: /Autosuggest/Topics/
• Method: GET or POST
• Content-Type: application/x-www-form-urlencoded
• Mandatory parameters: query, token
• Optional parameters used: limit, include
• Example GET request: https://api.mapegy.com/Autosuggest/Topics/?query=Fuel&token=fr9Ch_2BDFI-rBR6edo0Lb-0JRVP6lBb5Fb7p4FYND0Xnlk_2NpNNcJ1IAYlO3SL&limit=5&include=term,description,web_links 
• ‍Example response suggested topic:

[
  {
    "term": "Fuel cell",
    "topic_id": 5693111,
    "web_links": {
      "images": [
        "https://upload.wikimedia.org/wikipedia/commons/thumb/2/22/Fuel_cell_NASA_p48600ac.jpg/300px-Fuel_cell_NASA_p48600ac.jpg"
      ],
      "wikipedia": "https://en.wikipedia.org/?curid=11729"
    },
    "description": "A fuel cell is a device that converts the chemical energy from a fuel into electricity through a chemical reaction of positively charged hydrogen ions with oxygen or another oxidizing agent. Fuel cells are different from batteries in requiring a continuous source of fuel and oxygen or air to sustain the chemical reaction, whereas in a battery the chemicals present in the battery react with each other to generate an electromotive force (emf). Fuel cells can produce electricity continuously for as long as these inputs are supplied. The first fuel cells were invented in 1838. The first commercial use of fuel cells came more than a century later in NASA space programs to generate power for satellites and space capsules. Since then, fuel cells have been used in many other applications. Fuel cells are used for primary and backup power for commercial, industrial and residential buildings and in remote or inaccessible areas.",
    "language_code": "EN",
    "score_relevance": 0.421,
    "web_links_broken": {}
  }
]