cURL Commands
Access Akkio through full cURL commands
These commands can be used directly in terminal (OSX), Command Prompt (Windows), or similar command line interfaces and built into any code environment. They require no setup or library and are the most straightforward REST API implementation.
API Keys
As noted in the code samples below, you must get your API keys and copy them into your API code. Those can be found under the team settings page at the bottom of the Akkio app.
Syntax notes
Expand each section to see what parameters must be replaced with specific values. For example, where you see 'api_key,' you must replace it with your actual API key from team settings.
Datasets
Get Dataset(s)
Get Dataset(s)
GET
https://api.akkio.com/v1/datasets
Get all datasets in your organization, or optionally get a specific dataset
Query Parameters
Name | Type | Description |
---|---|---|
id | string | (Optional): If dataset ID is included, only the specific dataset is returned |
api_key* | string | Your api key, accessible from https://app.akkio.com/team-settings |
Create Dataset
Create Dataset
POST
https://api.akkio.com/v1/datasets
Creates a dataset with a given name
Request Body
Name | Type | Description |
---|---|---|
name* | string | The name of the dataset to be created |
api_key* | string | Your API key, accessible from https://app.akkio.com/team-settings |
dataset | String | The path to the CSV you are using to create the dataset |
Add Rows To Dataset
Add Rows To Dataset
POST
https://api.akkio.com/v1/datasets
Request Body
Name | Type | Description |
---|---|---|
rows | array | List of rows in form [{'field name 1': 'value 1', 'field name 2': 0}, {...}, ...] |
id | string | The ID of the dataset to add rows to |
api_key * | string | Your API key, accessible from https://app.akkio.com/team-settings |
NOTE! The first time you add data to your dataset, it will define the schema for that dataset
When passing data via the form body, make sure the JSON is of the form:
{
"rows": [
{<row1>},
{<row2>}
]
}
Delete Dataset
Delete Dataset
DELETE
https://api.akkio.com/v1/datasets
Deletes a given dataset from a given ID
Request Body
Name | Type | Description |
---|---|---|
api_key* | string | Your API key, accessible from https://app.akkio.com/team-settings |
id | string | The ID of the dataset |
Models
Make Prediction
Make Prediction
POST
https://api.akkio.com/v1/models
Request Body
Name | Type | Description |
---|---|---|
api_key* | string | Your api key, accessible from https://app.akkio.com/team-settings |
data* | array | Data in the format of: [{'field name 1': 'value 1', 'field name 2': 0}, {...}, ...] |
id* | string | The ID of the model to make the prediction with |
Get All Models
Get All Models
GET
https://api.akkio.com/v1/models
Query Parameters
Name | Type | Description |
---|---|---|
api_key* | string | Your api key, accessible from https://app.akkio.com/team-settings |
Delete Model
Delete Model
DELETE
https://api.akkio.com/v1/models
Request Body
Name | Type | Description |
---|---|---|
id* | string | The ID of the model to be deleted |
api_key* | string | Your api key, accessible from https://app.akkio.com/team-settings |
Last updated