The Prediction API provides a programmatic way to interact with Analyses you build in Kraken. It is designed to support the integration of Kraken into other applications such as Business Intelligence (BI) platforms, business rules engines, and CRM.

Version

The current version of the API is 1.0.

Authentication

Authentication is managed using an API key that must be included in the authorization header for every call as a token.

Authorization: token [API key here]

HTTP Codes

• 200 will be returned if the call was successful
• 400 if there is an error with the request

Rate Limiting

Currently, there is no rate limit for the API. However, if we find that this is being abused we will block the API key and IP address if necessary.

Base URL

The base URL for all calls is:

http://api.bigsquid.com/predictionapi/

Example:

http://api.bigsquid.com/predictionapi/analyses/12345abc-1ab2-12a1-12ab-1ab234c567d8