Information

No authentication is required to access this API. All resources are fully open and available. Please don't purposely spam this API with excessive requests in an attempt to crash it.

Getting a compliment

GET /api/v1/compliment

Provides a random compliment from compliments.txt.

Name Description Values Required
type The type of compliment returned. normal, markov Yes
format The format the data will be returned in. Defaults to json. json No
name The name for the compliment to be addressed to. Any valid string No
GET https://cameron-api.herokuapp.com/api/v1/compliment?type=normal&name=josh

{
	"compliment": "Josh, your ability to recall random factoids at just the right time is impressive.",
	"positivity": 5,
	"success": true
}

Submitting a compliment

POST /api/v1/contribute

Submits a compliment. Must evaluate a sufficient positivity (using Sentimood) to be submitted. Sentiment is evalutated based on positive words in compliment.

Name Description Values Required
compliment The compliment the user wishes to submit. Any valid string Yes
name The user's full name. Any valid string Yes
POST https://cameron-api.herokuapp.com/api/v1/contribute?compliment=Your%20smile%20brightens%20up%20everyone%27s%20day%20and%20brings%20smiles%20to%20everyone%20who%20sees&name=Josh%20Trommel

{
	"success": true
}