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
ofOutput format.json xml imgOptional. Default:json
langIt specifies the language in which the text must be analyzed.en: English
es: Spanish
it: Italian
fr: French
pt: Portuguese
ca: Catalan
ilangIt specifies the language in which the values returned will appear (in the case where they are known). Check the response section to see which fields are affected.en: English
es: Spanish
it: Italian
fr: French
pt: Portuguese
ca: Catalan
Optional. Default: same as lang
verboseVerbose mode. When active, it shows additional information about the morphosyntactic tagsets and sentiment analysis. It provides an in depth description of the tagsets and shows the changes applied to the basic polarity of the different polarity terms detected.y: enabled
n: disabled
Optional. Default: verbose=n
txtText to analyzeUTF-8 encoded text (plain text, HTML or XML).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.
txtfThe text format parameter specifies if the text included in the txt parameter uses markup language that needs to be interpreted (known HTML tags and HTML code will be interpreted, and unknown tags will be ignored).plain markupOptional. Default: txtf=plain
uwDeal with unknown words. This feature adds a stage to the topic extraction in which the engine, much like a spellchecker, tries to find a suitable analysis to the unknown words resulted from the initial analysis assignment. It is specially useful to decrease the impact typos have in text analyses.y: enabled
n: disabled
Optional. Default: uw=n
rtDeal with relaxed typography. This parameter indicates how reliable the text (as far as spelling, typography, etc. are concerned) to analyze is, and influences how strict the engine will be when it comes to take these factors into account in the topic extraction.y: enabled
u: enabled only for user dictionary
n: disabled
Optional. Default: rt=n
dmType of disambiguation applied. It is accumulative, that is, the semantic disambiguation mode will also include morphosyntactic disambiguation.n: no disambiguation
m: morphosyntactic disambiguation
s: semantic disambiguation
Optional. Default: dm=s
sdgSemantic disambiguation grouping. This parameter will only apply when semantic disambiguation is activated (dm=s). See disambiguation grouping for a more in depth explanation.n: none
g: global intersection
t: intersection by type
l: intersection by type - smallest location
Optional. Default: sdg=l
contDisambiguation context. Context prioritization for entity semantic disambiguation. See context disambiguation for a more in depth explanation.Optional. Default: cont=""
udThe user dictionary allows to include user-defined entities and concepts in the analysis. 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. Several dictionaries can be combined separating them with |.Name of your user dictionaries.Optional. Default: ud=""
ttThe list of topic types to extract will be specified through a string with the letters assigned to each one of the topic types that are to be extracted.e: named entities
c: concepts
t: time expressions
m: money expressions
n: quantity expressions [beta]
o: other expressions
q: quotations
r: relations
a: all
Optional. Default: tt=""
stShow subtopics. This parameter will indicate if subtopics are to be shown. See subtopics for a more in depth explanation.y: enabled
n: disabled
Optional. Default: st=n
timerefThis value allows to set a specific time reference to detect the actual value of all the relative time expressions detected in the text. It only applies when time expressions are enabled in tt.YYYY-MM-DD hh:mm:ss GMT±HH:MMOptional. Default: current time at the moment the request is made.
smSentiment model chosen. If sent empty, sentiment analysis info will not be included in the response.general: general model. Automatic language detection.Optional. Default: sm=""
egpExpand global polarity. This mode allows you to choose between two different algorithms for the polarity detection of entities and concepts. Enabling the parameter gives less weight to the syntactic relationships, so it's recommended for short texts with unreliable typography. It only applies when sm!="".y: enabled
n: disabled
Optional. Default: egp=n


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.