API Reference
Log In
API Reference

Projects

Overview

Projects allow to run automated processes that include shared credentials, service accounts, and others. They have a name, description, and a Project Key associated, that can complete full job lifecycles. Projects may be private or visible to everyone in a team.

A project's dashboard provides the amount of inputs processed, predictions made, CPU usage, models used, available data sources, explainability details, drift details, and job history. The models used list includes the version, data processed, average latency, and drift level. Data sources include AWS S3 buckets and databases where the project's models can access input data.

The projects object

{
  "identifier": "...",
  "name": "...",
  "description": "...",
  "status": "...",
  "visibility": "...",
  "accessKeys": [],
  "user": {},
  "createdAt": "...",
  "updatedAt": "..."
}
ParameterTypeDescription
identifierstringThe project’s identifier.
namestringThe project’s name.
descriptionstringThe project’s description.
statusstringThe project’s status. Options are ACTIVE, INACTIVE, and DELETED.
visibilitystringThe project’s visibility. Options are PUBLIC and PRIVATE.
accessKeysarrayAn array of objects that contain the project’s API key prefixes.
userobjectAn object that contains all the project creator’s user parameters.
createdAtstringThe date the project was created in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
updatedAtstringThe date the project was updated in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.