API Doc-Image Classification API Documentation

API Summery:

The service can identify the contents of the uploaded image, given a number of classification label describing the image content.

Application scenarios:

stock image platforms, photo community sites, image sharing Apps

Image Classification:Uploading Image
Image Classification:Using Image URL

API end point : http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify

Image Format Requirement: JPG format, image width and length each for 300 – 1200 pix

Request Method :POST

Request Parameters(body) :

Parameter Name	Type	Required	Parameter Location	Description	Default Value
apikey	string	Yes	header	API Key	None
fmt	string	No	header	Response format: json or xml	json

apikey	string	Yes	header	API Key	None
photo	file	Yes	body	Image for uploading	None

														
Curl 'http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify ' -v -F photo=@dog1.jpg  -F  apikey=your apikey 
															
Above Curl request upload an image dog1.jpg, by using your apikey, values of other parameters are as default

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.Charset;

import org.apache.http.HttpEntity;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class ApiIcfPostImgTest {
	    public static final String APPKEY ="******************************";//APIKEY
	    
	    public static String postImg(File file) throws IOException{
	    		CloseableHttpClient httpClient = HttpClients.createDefault();
	            CloseableHttpResponse response = null;
	            ContentType contentType = ContentType.create(HTTP.PLAIN_TEXT_TYPE, HTTP.UTF_8);
	            String result =null;
	            try {
	                HttpPost httppost = new HttpPost("http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify");
	                FileBody bin = new FileBody(file);
	                StringBody keyBody = new StringBody(APPKEY , contentType);
	                MultipartEntityBuilder builder = MultipartEntityBuilder.create();
	                builder.addPart("apikey", keyBody).addPart("photo", bin);
	                HttpEntity reqEntity =  builder.build();
	                httppost.setEntity(reqEntity);
	                response = httpClient.execute(httppost);
	                HttpEntity resEntity = response.getEntity();
	                if (resEntity != null) {
	                   // result = ConvertStreamToString(resEntity.getContent(), "UTF-8");
	                    String charset = "UTF-8";   
	      			  String content=EntityUtils.toString(response.getEntity(), charset);   
	                    System.out.println(content);
	                }
	                EntityUtils.consume(resEntity);
	            }catch(Exception e){
	                e.printStackTrace();
	            }finally {
	                response.close();
	                httpClient.close();
	            }
	            return result;
	    }
	    
	
	public static void main(String[] args) throws ClientProtocolException, IOException {
		try {
			postImg(new File("dog1.jpg"));
			/*Above request upload an image dog1.jpg, by using your apikey, values of other parameters are as default*/
		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}
}

# test_client.py
import requests


data = {
		'apikey': '********************************'
       }
files = [
        ('imgFile', ('dog1.jpg', open('dog1.jpg', 'rb'), 'image/jpg'))
]       
response = requests.post('http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify', data=data, files=files)
print(response.text)


#Above request upload an image dog1.jpg, by using your apikey, values of other parameters are as default

require 'vendor/autoload.php';
use GuzzleHttp\Client;

$apikey = '*************';
$filebody = fopen('dog1.jpg', 'r');
$client = new GuzzleHttp\Client(['base_uri' => 'http://www.visualsearchapi.com:7080/wztimgsvr/']);
$response = $client->request('POST',  'iclassify/iclassify', [
    'multipart' => [
	        [
	            'name'     => 'apikey',
	            'contents' => $apikey,
	        ]

		]
]);

$rbody = $response->getBody();
echo $rbody;

#Above request upload an image dog1.jpg, by using your apikey, values of other parameters are as default

Detailed use of tutorials

using System;  
using System.Collections.Generic;  
using System.Linq;  
using System.Text;  
using System.Net.Security;  
using System.Security.Cryptography.X509Certificates;
using System.Collections;
using System.Collections.Specialized;
using System.Net;  
using System.IO;  
using System.IO.Compression;  
using System.Text.RegularExpressions;
namespace ConsoleApplication2
{
  class Program
    {
        public static string HttpUploadFile(string url, string file, string paramName, string contentType, NameValueCollection nvc)
        {
            string result = string.Empty;
            string boundary = "---------------------------" + DateTime.Now.Ticks.ToString("x");
            byte[] boundarybytes = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "\r\n");

            HttpWebRequest wr = (HttpWebRequest)WebRequest.Create(url);
            wr.ContentType = "multipart/form-data; boundary=" + boundary;
            wr.Method = "POST";
            wr.KeepAlive = true;
            wr.Credentials = System.Net.CredentialCache.DefaultCredentials;

            Stream rs = wr.GetRequestStream();

            string formdataTemplate = "Content-Disposition: form-data; name=\"{0}\"\r\n\r\n{1}";
            foreach (string key in nvc.Keys)
            {
                rs.Write(boundarybytes, 0, boundarybytes.Length);
                string formitem = string.Format(formdataTemplate, key, nvc[key]);
                byte[] formitembytes = System.Text.Encoding.UTF8.GetBytes(formitem);
                rs.Write(formitembytes, 0, formitembytes.Length);
            }
            rs.Write(boundarybytes, 0, boundarybytes.Length);

            string headerTemplate = "Content-Disposition: form-data; name=\"{0}\"; filename=\"{1}\"\r\nContent-Type: {2}\r\n\r\n";
            string header = string.Format(headerTemplate, paramName, file, contentType);
            byte[] headerbytes = System.Text.Encoding.UTF8.GetBytes(header);
            rs.Write(headerbytes, 0, headerbytes.Length);

            FileStream fileStream = new FileStream(file, FileMode.Open, FileAccess.Read);
            byte[] buffer = new byte[4096];
            int bytesRead = 0;
            while ((bytesRead = fileStream.Read(buffer, 0, buffer.Length)) != 0)
            {
                rs.Write(buffer, 0, bytesRead);
            }
            fileStream.Close();

            byte[] trailer = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "--\r\n");
            rs.Write(trailer, 0, trailer.Length);
            rs.Close();

            WebResponse wresp = null;
            try
            {
                wresp = wr.GetResponse();
                Stream stream2 = wresp.GetResponseStream();
                StreamReader reader2 = new StreamReader(stream2);

                result = reader2.ReadToEnd();
            }
            catch (Exception ex)
            {
                if (wresp != null)
                {
                    wresp.Close();
                    wresp = null;
                }
            }
            finally
            {
                wr = null;
            }

            return result;
        }
        static void Main(string[] args)
            {
        
           	NameValueCollection nvc1 = new NameValueCollection();
            nvc1.Add("apikey", "**************");
            String s1 =  HttpUploadFile("http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify", @"dog1.jpg", "photo", "image/jpeg", nvc1);
            Console.WriteLine(s1);
            Console.ReadKey();
            //Above request upload an image dog1.jpg, by using your apikey, values of other parameters are as default
         }
        }
}

Parameter Name	Type	Required	Parameter Location	Description	Default Value
apikey	string	Yes	header	API Key	None
fmt	string	No	header	Response format: json or xml	json
imgurl	string	Yes	body	Image URL	None

													
Curl Demo1:
curl 'http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify ' -v  -F apikey=your apikey -F  imgURL=http://www.xyz.com/img/dog1.jpg  
													
Above Curl request is to search a result by using an input image located at image URL http://www.xyz.com/img/dog1.jpg, by using your apikey, values of other parameters as default.  
													</div>
													<p>
													</p>
												</div>
												<div class="tab-pane fade in  " id="urljavatab" style="padding:20px" >
													<textarea  readonly="readonly" rows="15" cols="110"  >
import java.io.IOException;

import org.apache.http.HttpEntity;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class ApiIcfImgUrlTest {
    public static final String APPKEY ="********************************";
	public static String postImgURL(String imgURL) throws IOException{
			
			CloseableHttpClient httpClient = HttpClients.createDefault();
	        CloseableHttpResponse response = null;
	        ContentType contentType = ContentType.create(HTTP.PLAIN_TEXT_TYPE, HTTP.UTF_8);
	        String result =null;
	        try {
	            HttpPost httppost = new HttpPost("http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify");
	            StringBody imgUrlBody = new StringBody(imgURL , contentType);
	            StringBody keyBody = new StringBody(APPKEY , contentType);
	            MultipartEntityBuilder builder = MultipartEntityBuilder.create();
	            builder.addPart("apikey", keyBody).addPart("imgURL", imgUrlBody);
	            HttpEntity reqEntity =  builder.build();
	            httppost.setEntity(reqEntity);
	            response = httpClient.execute(httppost);
	            HttpEntity resEntity = response.getEntity();
	            if (resEntity != null) {
	               // result = ConvertStreamToString(resEntity.getContent(), "UTF-8");
	                String charset = "UTF-8";   
	  			  String content=EntityUtils.toString(response.getEntity(), charset);   
	                System.out.println(content);
	            }
	            EntityUtils.consume(resEntity);
	        }catch(Exception e){
	            e.printStackTrace();
	        }finally {
	            response.close();
	            httpClient.close();
	        }
	        return result;
		}
	
	public static void main(String[] args) throws ClientProtocolException, IOException {
		try {
			postImgURL(" http://www.xyz.com/img/dog1.jpg");
			/*Above request is to search a result by using an input image located at image URL http://www.xyz.com/img/dog1.jpg, by using your apikey, values of other parameters as default.  */
		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		
	}
}
/*

# test_client.py
import requests


data = {
		'apikey': '********************************',
        "imgURL" : "http://www.xyz.com/img/dog1.jpg"
q2       }
response = requests.post('http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify', data)
print(response.text)


#Above request is to search a result by using an input image located at image URL http://www.xyz.com/img/dog1.jpg, by using your apikey, values of other parameters as default.

 $query = array(
      "imgurl" => "http://www.xyz.com/img/dog1.jpg",//
      "apikey" => "********************************_1"//APP Key
  );
  $result = post2("http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify",$query);
  echo($result);

 function post2($url, $data){//file_get_content
         
        $postdata = http_build_query(
            $data
        );
 
        $opts = array('http' =>
 
                      array(
                          'method'  => 'POST',
                          'header'  => 'Content-type: application/x-www-form-urlencoded',
                          'content' => $postdata,
                      )
 
        );
 
        $context = stream_context_create($opts);
        $result = file_get_contents($url, false, $context);
        return $result;
    }    


#Above request is to search a result by using an input image located at image URL http://www.xyz.com/img/dog1.jpg, by using your apikey, values of other parameters as default.

using System;  
using System.Collections.Generic;  
using System.Linq;  
using System.Text;  
using System.Net.Security;  
using System.Security.Cryptography.X509Certificates;
using System.Collections;
using System.Collections.Specialized;
using System.Net;  
using System.IO;  
using System.IO.Compression;  
using System.Text.RegularExpressions;
namespace ConsoleApplication2
{
    public class HttpWebResponseUtility
    {
        private static readonly string DefaultUserAgent = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.2; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)";
        
         public static HttpWebResponse CreatePostHttpResponse(string url, IDictionary<string, string> parameters, int? timeout,string path, string userAgent, Encoding requestEncoding, CookieCollection cookies)
        {
            if (string.IsNullOrEmpty(url))
            {
                throw new ArgumentNullException("url");
            }
            if (requestEncoding == null)
            {
                throw new ArgumentNullException("requestEncoding");
            }
            HttpWebRequest request = null;
           
            request = WebRequest.Create(url) as HttpWebRequest;
            request.Method = "POST";
            request.ContentType = "application/x-www-form-urlencoded";

            if (!string.IsNullOrEmpty(userAgent))
            {
                request.UserAgent = userAgent;
            }
            else
            {
                request.UserAgent = DefaultUserAgent;
            }

            if (timeout.HasValue)
            {
                request.Timeout = timeout.Value;
            }
            if (cookies != null)
            {
                request.CookieContainer = new CookieContainer();
                request.CookieContainer.Add(cookies);
            }

            Stream stream = request.GetRequestStream();
            if (path != null) 
            { 
                FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read);
                byte[] bArr = new byte[fs.Length];
                fs.Read(bArr, 0, bArr.Length);
                fs.Close();
               stream.Write(bArr, 0, bArr.Length);
            
            }
            
            if (!(parameters == null || parameters.Count == 0))
            {
                StringBuilder buffer = new StringBuilder();
                int i = 0;
                foreach (string key in parameters.Keys)
                {
                    if (i > 0)
                    {
                        buffer.AppendFormat("&{0}={1}", key, parameters[key]);
                    }
                    else
                    {
                        buffer.AppendFormat("{0}={1}", key, parameters[key]);
                    }
                    i++;
                }
                byte[] data = requestEncoding.GetBytes(buffer.ToString());
                stream.Write(data, 0, data.Length);
            
            }
            return request.GetResponse() as HttpWebResponse;
        }
       
        static void Main(string[] args)
        {
            string url = "http://www.visualsearchapi.com:7080/wztimgsvr/iclassify/iclassify";
            IDictionary<string, string> parameters = new Dictionary<string, string>();
            parameters.Add("apikey", "**************");
            parameters.Add("imgurl", "http://www.xyz.com/img/dog1.jpg");
            HttpWebResponse response = HttpWebResponseUtility.CreatePostHttpResponse(url, parameters, null, null, null, Encoding.UTF8, null);
            StringBuilder content = new StringBuilder();
            Stream responseStream = response.GetResponseStream();
            StreamReader sReader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            Char[] sReaderBuffer = new Char[256];
            int count = sReader.Read(sReaderBuffer, 0, 256);
            while (count > 0)
            {
                String tempStr = new String(sReaderBuffer, 0, count);
                content.Append(tempStr);
                count = sReader.Read(sReaderBuffer, 0, 256);
            }
            sReader.Close();
            Console.WriteLine(content.ToString());
            Console.ReadKey(); 
            //Above request is to search a result by using an input image located at image URL http://www.xyz.com/img/dog1.jpg, by using your apikey, values of other parameters as default.        
         }
        }
}

JSON Response Example:

{"class":"visualse.common.utils.IClassifyResultSet","nodeList":[{"class":"visualse.common.utils.IClassifyNode","nodeKwd":" kuvasz","nodeLabel":"02104029","nodeScore":0.426328},{"class":"visualse.common.utils.IClassifyNode","nodeKwd":" Sealyham terrier| Sealyham","nodeLabel":"02095889","nodeScore":0.123592},{"class":"visualse.common.utils.IClassifyNode","nodeKwd":" standard poodle","nodeLabel":"02113799","nodeScore":0.0685024},{"class":"visualse.common.utils.IClassifyNode","nodeKwd":" toypoodle","nodeLabel":"02113624","nodeScore":0.0557082},{"class":"visualse.common.utils.IClassifyNode","nodeKwd":" Great Pyrenees","nodeLabel":"02111500","nodeScore":0.0504554}],"numOfNodes":5,"timeMillSec":0.1683}

Download Java resources
Download Python resources
Download Php resources

Error Code Reference:

Error Codes Related to Access Control:

API_CODE_ERROR_exceeded_access_total	Exceeded API access limit in total
API_CODE_ERROR_exceeded_access_frequency	Exceeded API access frequency limit
API_CODE_ERROR_exceeded_access_frequency_min	Exceeded API access limit per minute
API_CODE_ERROR_exceeded_access_frequency_hr	Exceeded API access limit per hour
API_CODE_ERROR_exceeded_access_frequency_day	Exceeded API access limit per day
API_CODE_ERROR_exceeded_access_frequency_month	xceeded API access limit per month
API_CODE_ERROR_two_API_calls_time_too_close	Two API calls are too close in time
IMAGE_INDEX_CODE_ERROR_IMAGE_EXCEED_MAX_DOCS_PER_UID	Exceeded max number of images in index per user
API_CODE_ERROR_not_allow_write_index	Pause in adding image to index (server might be in maintain service, please wait )

Error Codes Related to Wrong Parameters：

API_CODE_ERROR_invalid_apikey	Invalid apikey
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_imgName	Invalid image name
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_imgUrl	Invalid image URL
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_catid_must_be_1_to_3000	Invalid image category (Must be 1-3000 Integer)
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_labels_must_be_positive_integer	Invalid label(Must be positive integer)
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_FIELDS_any_field_must_not_have_double_quote	Invalid image data, must not have double quote
IMAGE_INDEX_ITEM_CODE_ERROR_INVALID_LANG	Invalid language parameter(must be zh for Chinese or en for English)
IMAGE_INDEX_CODE_ERROR_DOWNLOAD_IMAGE	Error in downloading image, please check provided image URL
IMAGE_INDEX_CODE_ERROR_IMAGE_SIZE_TOO_BIG	Image size is too big(image must be 400 – 800PIX JPG format)
IMAGE_INDEX_DELETE_IMG_CODE_ERROR_NOT_FOUND_ITEM	Error in deleting, image not found