AlchemyML API V1.2.3
- API Reference
No results found
API Reference
The AlchemyML API allows you to use the functions that usually run on the AlchemyML website on your own website or application.
This is the API reference that will allow you to identify the different resources in which the API is organised and which you can retrieve, and it also supports methods to insert, update or delete many of these resources.
Each resource type has one or more data representations and one or more methods.
Datasets
| Endpoint | URL | Method |
|---|---|---|
| Delete | http://api.alchemyml.com/api/datasets/delete/ | POST |
| Upload | http://api.alchemyml.com/api/datasets/upload/ | POST |
| Statistical descriptors | http://api.alchemyml.com/api/datasets/statistical_descriptors/ | POST |
| Update | http://api.alchemyml.com/api/datasets/update/ | POST |
| List | http://api.alchemyml.com/api/datasets/list/ | POST |
Experiments
| Endpoint | URL | Method |
|---|---|---|
| Create | http://api.alchemyml.com/api/experiments/create/ | POST |
| Results | http://api.alchemyml.com/api/experiments/results/ | POST |
| Add to project | http://api.alchemyml.com/api/experiments/add-experiment-to-project/ | POST |
| Extract from project | http://api.alchemyml.com/api/experiments/extract-experiment-from-project/ | POST |
| Send | http://api.alchemyml.com/api/experiments/send-experiment/ | POST |
| List | http://api.alchemyml.com/api/experiments/list/ | POST |
| Delete | http://api.alchemyml.com/api/experiments/delete/ | POST |
| Statistical descriptors | http://api.alchemyml.com/api/experiments/statistical_descriptors/ | POST |
| Update | http://api.alchemyml.com/api/experiments/update/ | POST |
Projects
| Endpoint | URL | Method |
|---|---|---|
| List | http://api.alchemyml.com/api/projects/list/ | POST |
| Create | http://api.alchemyml.com/api/projects/create/ | POST |
| Delete | http://api.alchemyml.com/api/projects/delete/ | POST |
| Update | http://api.alchemyml.com/api/projects/update/ | POST |
Manual Operations
Post Modeling Operations
| Endpoint | URL | Method |
|---|---|---|
| Predictions | http://api.alchemyml.com/api/experiments/predictions/ | POST |
| Historical Predictions | http://api.alchemyml.com/api/experiments/historical-predictions/ | POST |
| Historical Data Aggregation | http://api.alchemyml.com/api/experiments/historical-data-aggregations/ | POST |
Authentication
Sign-up
Indispensable to make use of the API.
This will give you access to AlchemyML's functionalities, experimenting in just a few lines of code the automation of data lifecycle.
At this moment, we have language bindings in Python but we are working to introduce requests to our API in any other programming languages. You can view AlchemyML API code in the dark area to the right.
For any doubt or further information, please feel free to consult us.
Get your token (access key)
This call returns the necessary token to be used from now on for the API requests. To be able to make use of the API before all it is necessary to sign-up.
This information is available also in the user profile under the section Account settings
username
string
Required
password
string
Required
Token
string
The access key in string format.
Requests status codes
| HTTP Code | Note |
|---|---|
| 200 | OK - indicates that the request has been successful. |
| 400 | Bad Request - Your request is invalid or expired. Please request a new one. |
| 401 | Unauthorized - Your API key is wrong. |
| 403 | Forbidden – Requested resource is available for registered users. |
| 404 | Not Found - The specified resource could not be found. |
| 405 | Method Not Allowed – Invalid method used. Check documentation. |
| 406 | Not Acceptable – Input resource format not valid. Check documentation. |
| 500 | Internal Server Error - We had a problem with our server. Try again later. |
| 503 | Service Unavailable - We're temporarily offline for maintenance. Please try again later. |