Nexosis Api

API change history

Imports: Import from S3

Import data into Axon from a file on S3

Try it

Request URL

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "dataSetName": "Location-A",
  "bucket": "nexosis-sample-data",
  "path": "LocationA.csv",
  "region": "us-east-1"
}
{
  "description": "The parameters needed to import data into Axon from AWS S3",
  "required": [
    "dataSetName",
    "bucket",
    "path"
  ],
  "type": "object",
  "properties": {
    "dataSetName": {
      "description": "The DataSet into which the data should be imported",
      "type": "string"
    },
    "bucket": {
      "description": "The AWS S3 bucket containing the file to import",
      "type": "string"
    },
    "path": {
      "description": "The path to the file to be imported",
      "type": "string"
    },
    "region": {
      "description": "The AWS Region in which the S3 bucket is located.  Defaults to us-east-1",
      "type": "string"
    },
    "columns": {
      "description": "Metadata about each column in the dataset",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "dataSetName": "Location-A",
    "bucket": "nexosis-sample-data",
    "path": "LocationA.csv",
    "region": "us-east-1"
  }
}
{
  "dataSetName": "Location-A",
  "bucket": "nexosis-sample-data",
  "path": "LocationA.csv",
  "region": "us-east-1"
}
{
  "description": "The parameters needed to import data into Axon from AWS S3",
  "required": [
    "dataSetName",
    "bucket",
    "path"
  ],
  "type": "object",
  "properties": {
    "dataSetName": {
      "description": "The DataSet into which the data should be imported",
      "type": "string"
    },
    "bucket": {
      "description": "The AWS S3 bucket containing the file to import",
      "type": "string"
    },
    "path": {
      "description": "The path to the file to be imported",
      "type": "string"
    },
    "region": {
      "description": "The AWS Region in which the S3 bucket is located.  Defaults to us-east-1",
      "type": "string"
    },
    "columns": {
      "description": "Metadata about each column in the dataset",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "dataSetName": "Location-A",
    "bucket": "nexosis-sample-data",
    "path": "LocationA.csv",
    "region": "us-east-1"
  }
}

Response 200

Success

{
  "importId": "8e22a7c1-1037-4a7a-acdf-f8bad2e414ac",
  "type": "s3",
  "status": "requested",
  "dataSetName": "Location-A",
  "parameters": {
    "bucket": "nexosis-sample-data",
    "path": "LocationA.csv"
  },
  "requestedDate": "2017-10-17T18:06:05.254022+00:00",
  "statusHistory": [],
  "messages": [],
  "columns": {},
  "links": []
}
{
  "type": "object",
  "properties": {
    "importId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "s3"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated"
      ],
      "type": "string"
    },
    "dataSetName": {
      "type": "string"
    },
    "parameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "requestedDate": {
      "format": "date-time",
      "type": "string"
    },
    "statusHistory": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "requested",
              "started",
              "completed",
              "cancelled",
              "failed",
              "estimated"
            ],
            "type": "string"
          }
        }
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "columns": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}
{
  "importId": "8e22a7c1-1037-4a7a-acdf-f8bad2e414ac",
  "type": "s3",
  "status": "requested",
  "dataSetName": "Location-A",
  "parameters": {
    "bucket": "nexosis-sample-data",
    "path": "LocationA.csv"
  },
  "requestedDate": "2017-10-17T18:06:05.254022+00:00",
  "statusHistory": [],
  "messages": [],
  "columns": {},
  "links": []
}
{
  "type": "object",
  "properties": {
    "importId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "s3"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated"
      ],
      "type": "string"
    },
    "dataSetName": {
      "type": "string"
    },
    "parameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "requestedDate": {
      "format": "date-time",
      "type": "string"
    },
    "statusHistory": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "requested",
              "started",
              "completed",
              "cancelled",
              "failed",
              "estimated"
            ],
            "type": "string"
          }
        }
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "columns": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}

Response 400

badrequest

{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "importId": [
      "Value for importId must be a valid GUID"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "importId": [
      "Value for importId must be a valid GUID"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Response 404

notfound

{
  "statusCode": 404,
  "message": "Item of type import with identifier 8e22a7c1-1037-4a7a-acdf-f8bad2e414ac was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "import",
    "itemId": "8e22a7c1-1037-4a7a-acdf-f8bad2e414ac"
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 404,
  "message": "Item of type import with identifier 8e22a7c1-1037-4a7a-acdf-f8bad2e414ac was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "import",
    "itemId": "8e22a7c1-1037-4a7a-acdf-f8bad2e414ac"
  }
}
{
  "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 POST "https://ml.nexosis.com/v1/imports/S3"
-H "Content-Type: application/json"
-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/imports/S3?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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/imports/S3");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            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/imports/S3?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("api-key","{subscription key}");
            },
            type: "POST",
            // 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/imports/S3";
    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:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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/imports/S3');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("POST", "/v1/imports/S3?%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
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('ml.nexosis.com')
    conn.request("POST", "/v1/imports/S3?%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/imports/S3')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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