Summary
All the available API routes are listed below.
Managing sources#
| Method | URL | Description |
|---|---|---|
| GET | /api/v1/sources | Retrieve metadata about all accessible sources |
| GET | /api/v1/sources/<organisation> | Retrieve metadata about all sources in an organisation |
| GET | /api/v1/sources/<organisation>/<source_name> | Retrieve metadata about a source by name |
| GET | /api/v1/sources/id:<source_id> | Retrieve metadata about a source by id |
| PUT | /api/v1/sources/<organisation>/<source_name> | Create a source |
| POST | /api/v1/sources/<organisation>/<source_name> | Update a source |
| DELETE | /api/v1/sources/id:<source_id> | Delete a source by id |
Managing datasets#
| Method | URL | Description |
|---|---|---|
| GET | /api/v1/datasets | Retrieve metadata about all accessible datasets |
| GET | /api/v1/datasets/<organisation> | Retrieve metadata about all datasets in an organisation |
| GET | /api/v1/datasets/<organisation>/<dataset_name> | Retrieve metadata about a dataset by name |
| PUT | /api/v1/datasets/<organisation>/<dataset_name> | Create a dataset |
| POST | /api/v1/datasets/<organisation>/<dataset_name> | Update a dataset |
| DELETE | /api/v1/datasets/<organisation>/<dataset_name> | Delete a dataset by name |
Uploading comments#
| Method | URL | Description |
|---|---|---|
| POST | /api/v1/sources/<organisation>/<source_name>/sync | Create or update comments |
| POST | /api/v1/sources/<organisation>/<source_name>/sync-raw-emails | Create or update comments from raw emails |
Managing comments#
| Method | URL | Description |
|---|---|---|
| GET | /api/v1/sources/<organisation>/<source_name>/comments/<comment_id> | Retrieve comment by ID |
| DELETE | /api/v1/sources/<organisation>/<source_name>/comments?ids=<comment_id0>[,<comment_id1>,...] | Delete comments by ID |
Fetching predictions and model statistics#
| Method | URL | Description |
|---|---|---|
| GET | /api/v1/datasets/<organisation>/<dataset_name>/labellers/<version>/validation | Get model statistics |
| POST | /api/v1/datasets/<organisation>/<dataset_name>/labellers/<version>/predict | Get predictions |
| POST | /api/v1/datasets/<organisation>/<dataset_name>/labellers/<version>/predict-comments | Get predictions by comment ID |
| POST | /api/v1/datasets/<organisation>/<dataset_name>/labellers/<version>/predict-raw-emails | Get predictions for raw emails |
Fetching predictions with Trigger API#
| Method | URL | Description |
|---|---|---|
| GET | /api/v1/datasets/<organisation>/<dataset_name>/triggers/<trigger_name> | Get a Trigger |
| PUT | /api/v1/datasets/<organisation>/<dataset_name>/triggers | Create a Trigger |
| PUT | /api/v1/datasets/<organisation>/<dataset_name>/triggers/<trigger_name>/exceptions | Tag an exception |
| POST | /api/v1/datasets/<organisation>/<dataset_name>/triggers/<trigger_name>/fetch | Fetch comments from a Trigger |
| POST | /api/v1/datasets/<organisation>/<dataset_name>/triggers/<trigger_name>/advance | Advance a Trigger |
| POST | /api/v1/datasets/<organisation>/<dataset_name>/triggers/<trigger_name>/reset | Reset a Trigger |
| DELETE | /api/v1/datasets/<organisation>/<dataset_name>/triggers/<trigger_name> | Delete a Trigger |