Datasets API Documentation
Welcome to the Datasets API documentation. This guide provides comprehensive information to help you integrate and utilize our APIs for easily saving and managing datasets in Enkrypt.Purpose
The Datasets API is designed to help you save datasets in Enkrypt for usage in our Redteam and other APIs. By leveraging this API, you can seamlessly store your datasets so that you can reuse them across different services we offer.Offered APIs
Our API suite includes the following endpoints:- add-task: This endpoint allows you to add a new task in Enkrypt to generate a new Dataset.
- get-datacard: This endpoint retrieves the datacard of a saved Dataset.
- get-dataset: This endpoint retrieves a saved Dataset from Enkrypt.
- get-summary: This endpoint retrieves the list of unique test_types generated in the Dataset.
- list-tasks: This endpoint retrieves the list of Datasets tasks in Enkrypt i.e. all the generated Datasets.
Obtaining an API Key
To get started with the Datasets API, you need to obtain an API key. Follow these steps:- Login: Access your account at app.enkryptai.com.
- Get API Key: Navigate to the API section to get your unique API key.
- Authentication: Use this API key in the authorization headers of your leaderboard API calls.