Getting Started

Get Rosette API Access

Before you start, make sure you have a Rosette API key. Head to developer.rosette.com to start your 30-day trial of the Rosette API. Check out the documentation first, then find your API key in your developer portal and make sure it is passed in as a parameter every time your code opens an API connection.

Install from NPM

Install the module with: npm install rosette-api

Run the language detection example

var rosette-api = require('rosette-api');

var api = new Api(API_KEY);
var endpoint = "language";
var content = "Por favor Señorita, says the man.";
api.parameters.content = content;

api.rosette(endpoint, function(err, res){
	if(err){
		console.log(err);
	} else {
		console.log(JSON.stringify(res, null, 2));
	}
});

API Parameters

Parameter	Endpoint	Required
content	categories, entities, language, morphology, relationships, sentences, sentiment, tokens	Either content or contentUri required
contentUri	categories, entities, language, morphology, relationships, sentences, sentiment, tokens	Either content or contentUri required
contentType	categories, entities, language, morphology, relationships, sentences, sentiment, tokens	No
language	categories, entities, language, morphology, relationships, sentences, sentiment, tokens, name similarity	No
documentFile	categories, entities, language, morphology, relationships, sentences, sentiment, tokens	No
name1	name similarity	Yes
name2	name similarity	Yes
name	name translation	Yes
targetLanguage	name translation	Yes
entityType	name translation	No
sourceLanguageOfOrigin	name translation	No
sourceLanguageOfUse	name translation	No
sourceScript	name translation	No
targetScript	name translation	No
targetScheme	name translation	No
options	relationships	No
accuracyMode	relationships	Yes
linked	entities	No
explain	sentiment	No
shortString	sentiment	No
morphology	morphology	Yes

Additional Examples

See examples.

Additional Information

See Rosette API site