Nexosis Api

API change history

Sessions: Retrieve session status

Gets completion status of a particular session as an HTTP response header

The response to this endpoint adds a nexosis-session-status HTTP response header indicating the completion status of the session.

Try it

Request URL

Request parameters

string

Format - uuid. Session identifier of the session to retrieve

Request headers

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

Response 400

One or more parameters are invalid

{
  "statusCode": 0,
  "message": "string",
  "errorType": "string",
  "errorDetails": {}
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 0,
  "message": "string",
  "errorType": "string",
  "errorDetails": {}
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Response 404

Specified session was not found

{
  "statusCode": 0,
  "message": "string",
  "errorType": "string",
  "errorDetails": {}
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 0,
  "message": "string",
  "errorType": "string",
  "errorDetails": {}
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X HEAD "https://ml.nexosis.com/v1/sessions/{sessionId}"
-H "api-key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("api-key", "{subscription key}");

            var uri = "https://ml.nexosis.com/v1/sessions/{sessionId}?" + queryString;

            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Head, uri));
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://ml.nexosis.com/v1/sessions/{sessionId}");


            URI uri = builder.build();
            HttpHead request = new HttpHead(uri);
            request.setHeader("api-key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/sessions/{sessionId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("api-key","{subscription key}");
            },
            type: "HEAD",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://ml.nexosis.com/v1/sessions/{sessionId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"HEAD"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"api-key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://ml.nexosis.com/v1/sessions/{sessionId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'api-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_HEAD);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("HEAD", "/v1/sessions/{sessionId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('ml.nexosis.com')
    conn.request("HEAD", "/v1/sessions/{sessionId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://ml.nexosis.com/v1/sessions/{sessionId}')


request = Net::HTTP::Head.new(uri.request_uri)
# Request headers
request['api-key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body