API Reference
Log In
API Reference

List all models' details

This endpoint returns a model list with all models and their versions. It includes all models' and versions' fields.

It can be sorted by version, createdAt, inputValidationSchema, createdBy, longDescription, technicalDetails, imagePrefix, status, isAvailable, repositoryName, sourceType, versionHistory, isExperimental, performanceSummary, lastActiveDateTime (never used models are always returned last), model.name, model.author, model.createdByFullName, processing.minimumParallelCapacity (defaults to 0), processing.maximumParallelCapacity (defaults to 1).

❗️

Be aware that the amount of information being retrieved may be very large making the response slow. Use filters and pagination to reduce the amount of information.

📘

This route accepts sort-by and direction query parameters described in the pagination guide.

📘

This collection route supports filters and pagination.

📘

Modzy returns the loadStatus and the runStatus objects if the model was added through the Model Deployment page.

👍

Roles

All the roles can access this route.

Query Params
string

Filters by name or version and returns similar matches.

string

Filters versions by number.

date-time

Filters versions by creation date in ISO8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

string

Filters versions by user id.

string

Filters versions by status. Values can be partial, canceled, rejected, deleted, active, or inactive. Separate multiple values with ;.

boolean

Filters versions by availability in the Library.

date-time

Filters versions by the last change date in ISO8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

boolean

Filters versions by status.

boolean

Filters versions by experimental status.

string
Defaults to c60c8dbd90

Filters models by identifier. Separate multiple values with ;.

string

Filters models by the organization that created them. Separate multiple values with ;.

string

Filters models by creator’s email. Separate multiple values with ;.

string

Filters models by creator’s full name. Separate multiple values with ;.

string

Filters models by name. Separate multiple values with ;.

string

Filters models by description.

boolean

Filters models by availability in the Library.

boolean

Filters models by expiration status.

boolean

Filters models by commercial status.

boolean

Filters models recommended by Modzy.

date-time

Filters models by latest use date. Format should be ISO8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Response

Language
Credentials
Request
Choose an example:
application/json