URL API Documentation

Overview

1. API Overview
2. Classify a text
3. Classify an URL
4. Example response

---

API Overview

Our hope is to provide an easy-to-use API using URL requests. Let us know if this is not the case! When a request is done to the server, a response is returned. The response will tell you if the request was successful and return whatever is relevant for your calls. Responses will be in XML or JSON while requests are in URL format as detailed below. As you may be familiar with, accessing classifier via the web can be done by browsing them. The URL API uses the same structure to access classifiers, that is: http://uclassify.com/browse/username/classifiername/operation?arguments

Operations

ClassifyText

Classifying a text with the URL API is easy, just use a 'ClassifyText' operation together with the appropiate arguments. Please note that all arguments should be URL encoded (HttpUtility.UrlEncode in C# and urlencode in PHP). uClassify has a 1MB limit per request however Web browsers (Internet Explorer, Firefox etc) usually limit the length of urls to between 2000 and 4000 characters.

Arguments

• readKey - (string) a read API key that has access to the specified classifier. Sign up to get yours for free. Remember to URL encode it!
• text - (string) the text you want to classify. Remember to URL encode it!
• removeHtml - (boolean, optional) specifies whether you want the API to remove html tags before classification. Possible values are: '1', '0', 'true', 'false'
• output - (string, optional) specifies the response format (default is 'xml'), can be 'xml' or 'json'
• version - (string, optional) specifies the api version (default is 1.00), can be '1.00' or '1.01'

Example - classify a text - response in XML

You must exchange 'YOUR_READ_API_KEY_HERE' with a real API key for this to work (sign up):

Example - classify a text - response in JSON

You must exchange 'YOUR_READ_API_KEY_HERE' with a real API key for this to work (sign up). Clicking on this link, will ask you to save a file (due to the nature of the MIME type application/json)

ClassifyUrl

Classifying an URL with the URL API is easy, just use the 'ClassifyUrl' operation together with the appropiate arguments. Please note that all arguments should be URL encoded (HttpUtility.UrlEncode in C# and urlencode in PHP).

Arguments

• readKey - (string) a read API key that has access to the specified classifier. Sign up to get yours for free. Remember to URL encode it!
• url - (string) the content on the url will be downloaded and classified. Remember to URL encode it!
• removeHtml - (boolean, optional) specifies whether you want the API to remove html tags before classification. Possible values are: '1', '0', 'true', 'false'
• output - (string, optional) specifies the response format (default is 'xml'), can be 'xml' or 'json'
• version - (string, optional) specifies the api version (default is 1.00), can be '1.00' or '1.01'

Example - classify a blog

You must exchange 'YOUR_READ_API_KEY_HERE' with a real API key for this to work (sign up):

Example Responses

JSON Example Response

I hope the JSON response is self explainatory, I am new to JSON, so if there are any issues with this format, please let me know! { "version" : "1.01", "success" : true, "statusCode" : 2000, "errorMessage" : "", "textCoverage" : 0.9, "cls1" : { "male" : 0.917, "female" : 0.083 } }

XML Example Response

You can read more about the response format here <?xml version="1.0" encoding="UTF-8" ?> <uclassify xmlns="http://api.uclassify.com/1/ResponseSchema" version="1.01"> <status success="true" statusCode="2000"/> <readCalls> <classify id="cls1"> <classification textCoverage="0.88"> <class className="Arabic" p="1.40364e-011"/> <class className="Bulgarian" p="1.1384e-011"/> <class className="Catalan" p="1.44192e-011"/> <class className="Croatian" p="1.04378e-011"/> <class className="Czech" p="9.73768e-012"/> <class className="Danish" p="3.30657e-008"/> <class className="Dutch" p="3.19794e-008"/> <class className="English" p="0.999998"/> <class className="Filipino" p="1.3816e-011"/> <class className="Finnish" p="1.15329e-011"/> <class className="French" p="1.58373e-011"/> <class className="German" p="1.29923e-011"/> <class className="Greek" p="1.13035e-011"/> <class className="Hebrew" p="1.29866e-011"/> <class className="Indonesian" p="2.12201e-011"/> <class className="Italian" p="1.34372e-011"/> <class className="Japanese" p="2.04885e-006"/> <class className="Korean" p="1.41196e-011"/> <class className="Latvian" p="1.24051e-011"/> <class className="Lithuanian" p="1.00874e-011"/> <class className="Norwegian" p="3.21954e-008"/> <class className="Polish" p="1.00793e-011"/> <class className="Portuguese" p="1.03789e-011"/> <class className="Romanian" p="1.19708e-011"/> <class className="Russian" p="1.03247e-011"/> <class className="Serbian" p="1.077e-011"/> <class className="Slovak" p="9.82641e-012"/> <class className="Slovenian" p="1.02132e-011"/> <class className="Spanish" p="1.35457e-011"/> <class className="Swedish" p="3.7041e-008"/> <class className="Ukrainian" p="1.07921e-011"/> <class className="Vietnamese" p="3.3623e-011"/> </classification> </classify> </readCalls> </uclassify> * Note on the response, ex and e-x is a scientific format for floating points.