Description of Interface

Connecting is very easy with the standard REST-API. You can download the Neuwo cheat sheet for more technical details.

GENERAL INFORMATION ABOUT THE INTERFACE

  • The Neuwon M1 interface is a REST API and can be found at m1api.neuwo.ai
  • The interface supports XML and JSON formats
  • Requests should primarily be POST requests
  • The interface has customer-specific constraints that can be adjusted upon request

Available methods

  1. GetAITopics: As keywords, it retrieves the best / GetCustomTopics for calls to incoming text, along with BrandSafety information and marketing categories. The desired list to be used for categories can be sent as a parameter, by default the IAB Content Taxonomy 2.2 list is used.
  2. *GetSimilar: Retrieves the IDs and corresponding weights of similar documents

*This requires history for background information

Feedback on all calls also always includes the probability of that feedback, such as the keyword score

Header information

The customer-specific key (token) and call-specific parameters must be located in the header as general information.

Typical information required is language tags (ISO 639-1 language code) and, if multiple keyword lists are used, their unique identifiers.

Description of GetAITopics:

Request to be sent:
Parameter Description
token Customer-specific identifier
content Text to be processed
lang ISO 639-1 language code, if not included, the language is identified automatically
format The desired response format, xml or json, defaults to xml
documentid Document ID, this is not mandatory
publicationid Publication ID, this is not mandatory
list The desired list against which the taxonomy is checked, by default IAB2.2

 

Response:
Parameter Description
status Ok or error, indicates if it succeeded or something is wrong
error Error information if one has occurred
lang ISO 639-1 language code, if not included, the language is identified automatically
Topics Return Topics (Tags)
– text Tag
– score Tag score
BrandSafety
– State Yes/No = Safe / Not Safe
Categories
– List List of Marketing Categories with scores

Description of GetAISimilar:

Request to be sent:
Parameter Description
token Customer-specific identifier
content Text to be processed
lang ISO 639-1 language code, if not included, the language is identified
format The desired response format, xml or json, defaults to xml
documentid Document ID, this is not mandatory
range Desired amount of time, in years backwards, e.g., 1 = one year
publicationid Publication ID, this is not mandatory
Response:
Parameter Description
status Ok or error, indicates if it succeeded or something is wrong
error Error information if one has occurred
lang ISO 639-1 language code, if not included, the language is identified automatically
Similar List of similar documents (document IDs)
– documentid Article ID
– headline Article header
– score Score given to the words

For full API-documentation, please contact us!