Do you have any questions? Just write us an email or ask us through the feedback section.

Request

Requests are made using GET or POST data submissions to the API entry point. Typically, a POST method is recommended in order to overcome the parameter maximum length limit associated to the GET method.

Request

Endpoint

This is the endpoint to access the API.

Service Method Url
Deep Categorization POST https://api.meaningcloud.com/deepcategorization-1.0 Console

If you are working with an on-premises installation, you will need to substitute api.meaningcloud.com by your own server address.

Parameters

These are the supported parameters.

Name Description Values Default
key The access key is required for making requests to any of our web services. You can get a valid access key for free just by creating an account at MeaningCloud. Required
of Output format. json Optional. Default: of=json
verbose When enabled, it shows additional information about the process (the terms that have been used in the classification). y (enabled)
n (disabled)
Optional. Default: verbose=n
txt Input text. UTF-8 encoded text (plain text, HTML or XML). Optional. Default: txt=""
url URL of the content to analyze. Currently only non-authenticated HTTP and FTP are supported. The content types supported for URL contents can be found here. Optional. Default: url=""
doc Input file with the content to analyze. The supported formats for file contents can be found here. Optional. Default: doc=""
model Categorization model to use. See supported models. Required
polarity Determines if categories will contain an associated polarity value. y (enabled)
n (disabled)
Optional. Default: verbose=n
ud The user dictionary allows to include user-defined entities and concepts in the categorization. It provides a mechanism to adapt the process to focus on specific domains or on terms relevant to a user's interests, either to increase the precision in any of the domains already taken into account in our ontology, to include a new one, or just to add a new semantic meaning to known terms. You can define you own dictionary here. Several user dictionaries can be used by separating them with '|'.

Important

The fields txt, doc and url are mutually exclusive; in other words, at least one of them must not be empty (a content parameter is required), and in cases where more than one of them has a value assigned, only one will be processed. The precedence order is txt, url and doc.

Supported Models

These are the models currently supported and the corresponding value to use in the model parameter.

  • IAB_2.0_es: IAB 2.0 in Spanish
  • IAB_2.0_en: IAB 2.0 in English
  • IntentionAnalysis_es: Intention Analysis in Spanish
  • IntentionAnalysis_en: Intention Analysis in English
  • VoC-Generic_es: Voice of the Customer in a generic domain in Spanish
  • VoC-Generic_en: Voice of the Customer in a generic domain in English
  • VoC-Banking_es: Voice of the Customer in the banking domain in Spanish
  • VoC-Banking_es: Voice of the Customer in the banking domain in English
  • VoC-Insurance_es: Voice of the Customer in the insurance domain in Spanish
  • VoC-Insurance_en: Voice of the Customer in the insurance domain in English
  • VoC-Retail_es: Voice of the Customer in the retail domain in Spanish
  • VoC-Retail_en: Voice of the Customer in the retail domain in English
  • VoE-Performance_es: Voice of the Employee, focused on performance reviews in Spanish
  • VoE-Performance_en: Voice of the Employee, focused on performance reviews in English
  • VoE-Organization_es: Voice of the Employee, focused on the employee's thoughts about the organization in Spanish
  • VoE-Organization_en: Voice of the Employee, focused on the employee's thoughts about the organization in English
  • VoE-ExitInterview_es: Voice of the Employee, focused on exit interviews in Spanish
  • VoE-ExitInterview_en: Voice of the Employee, focused on exit interviews in English

For detailed information on the categories each one of these models have, check the documentation.