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




keyAuthorization key for using MeaningCloud services. Create an account for free to create your key.Required
txtText to analyzeUTF-8 encoded plain text.Use only one
urlURL of the document to analyze. Non-authenticated HTTP(s) and FTP supported. See supported formats.
docInput file with the content to analyze. See supported formats.
modelCategorization model to use.See supported models.Required
verboseWhen enabled, it shows additional information about the process (the terms that have been used in the classification).y: enabled
n: disabled
Optional. Default: n
polarityDetermines if categories will contain an associated polarity value.y: enabled
n: disabled
Optional. Default: n
debugWhen enabled, it shows additional debug information about the rules that have been fired in the user defined model.y: enabled
n: disabled
Optional. Default: n
udThe 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. Several user dictionaries can be used by separating them with|.Name of your user dictionariesOptional.


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.