Version: Next

Summary

All the available API routes are listed below.

Managing sources

MethodURLDescription
GET/­api/­v1/­sourcesRetrieve 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

MethodURLDescription
GET/­api/­v1/­datasetsRetrieve 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

MethodURLDescription
POST/­api/­v1/­sources/­<organisation>/­<source_name>/­syncCreate or update comments
POST/­api/­v1/­sources/­<organisation>/­<source_name>/­sync-raw-emailsCreate or update comments from raw emails

Managing comments

MethodURLDescription
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

MethodURLDescription
POST/­api/­v1/­datasets/­­<organisation>/­­<dataset_name>/­­labellers/­­<version>/­­predictGet predictions
POST/­api/­v1/­datasets/­­<organisation>/­­<dataset_name>/­­labellers/­­<version>/­­predict-commentsGet predictions by comment ID
POST/­api/­v1/­datasets/­­<organisation>/­­<dataset_name>/­­labellers/­­<version>/­­predict-raw-emailsGet predictions for raw emails