@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Psycholinguistic Text Analytics
@base https://api.symanto.net
@version 1.0
@auth ApiKey x-api-key in header
@endpoints 8
@toc communication(1), emotion(1), ekman-emotion(1), personality(1), sentiment(1), topic-sentiment(1), brand-recommendation(1), language-detection(1)

@group communication
@endpoint POST /communication
@desc Communication & Tonality
@optional {all: bool=false}
@returns(200) Successful Response
@errors {422: Validation Error}

@endgroup

@group emotion
@endpoint POST /emotion
@desc Emotion Analysis
@optional {all: bool=false}
@returns(200) Successful Response
@errors {422: Validation Error}

@endgroup

@group ekman-emotion
@endpoint POST /ekman-emotion
@desc Emotion Analysis
@optional {all: bool=false}
@returns(200) Successful Response
@errors {422: Validation Error}

@endgroup

@group personality
@endpoint POST /personality
@desc Personality Traits
@optional {all: bool=false}
@returns(200) Successful Response
@errors {422: Validation Error}

@endgroup

@group sentiment
@endpoint POST /sentiment
@desc Sentiment Analysis
@optional {all: bool=false}
@returns(200) Successful Response
@errors {422: Validation Error}

@endgroup

@group topic-sentiment
@endpoint POST /topic-sentiment
@desc Extracts topics and sentiments and relates them.
@optional {domain: str(Ecom/Employee/Hotel/Restaurant) # Provide analysis domain for better extraction (optional)}
@returns(200)

@endgroup

@group brand-recommendation
@endpoint POST /brand-recommendation
@desc Predicts whether a phrase is a promoter, detractor or indifferent
@optional {domain: str(Airlines/Automotive/Banking/Ecom/Employee/Gaming/Hotel/Pharma/Retail/Restaurant/ConsumerElectronics) # (optional) Provide analysis domain for better extraction}
@returns(200)

@endgroup

@group language-detection
@endpoint POST /language-detection
@desc Language Detection
@returns(200) Successful Response
@errors {422: Validation Error}

@endgroup

@end