Eggplant DAI Model Execution Endpoints
Admin users can now generate API clients with a client_id and client_secret through the DAI UI.
Eggplant DAI uses the OAuth 2.0 authentication protocol with the client_credentials
grant type in order to enable access to REST API. This page explains how you can generate an API access key and secret, exchange those for a token, and use the token to call the remaining DAI REST API. For example, it can be used to call the Execution API which lets you run your models and interact with execution controls like Starting an Execution via REST. These services allow you to integrate this behavior into your DevOps toolchains.
Getting Started
The REST API is ready and available to use as soon as you finish installing Eggplant DAI. To gain access to the API, you need to:
- Find out where to send your credentials.
- Generate API client credentials via the user interface using the new experience. Requires DAI 6.2 or newer.
- Acquire an access token to authenticate with the DAI REST API.
As soon as you acquire an access token, you can start to test models with all the options that are available in the Eggplant DAI web app. After a run starts, you can leave it to process. An ID is returned which you can use to check the progress of a run. In addition, you can abort a run.