Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In Ellie v4.76, we added a new API endpoint for importing models. Here we’ll explain how to use this capability to programmatically import new Logical Models.

...

In general, you need two things to use the API endpoints:

  1. The APIs API must be enabled for your Ellie instance. By default, the API is not enabled for e.g. trials, and in some organizations, it might be completely disabled e.g. in case your IT department doesn’t want to have API endpoints available. If you’re unsure, you can always ask support@ellie.ai! There is no extra cost on enabling the API.

  2. You need to have an API key to authenticate. The API key is a token you can create & regenerate in Ellie’s admin interface (admin-level access needed). No API calls will go through unless a valid token is included. Note that the tokens are organization-wide, meaning that once you as an admin create one, it can be used by anyone in your organization.

...

You can access the API from any application or piece of code that can connect to send REST APIsrequests. We have provided a couple of examples in our GitHub code sample library here: https://github.com/ellieapi/ellie-connectors

...