Search Modaic documentation

Find a Modaic guide or API reference

Reference›API›models

List models

List supported base models and your accessible model repositories. Pass an entry's name to POST /v1/systemone.

Requires a Modaic bearer token with read:repository or write:repository scope. Personal tokens include your own repositories and those of organizations you belong to. Organization tokens include only that organization's repositories. Archived repositories are excluded.

This route has no request parameters. The response lists base models first, followed by repository models sorted by name. A listed repository may still need its model and questions configured before it can run decisions. A base model that is still in development is listed with a description saying so; decisions against it return 503 model_in_development. See supported base models.

GET/v1/models

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Response

modelsModel[]required

The available model entries.

Model entry
namestringrequired

Model identifier, such as mo, mo-fast, or acme/support-triage.

descriptionstringrequired

Model description. For a base model that is in development, the description says so. An unset repository description is returned as "".

typebase | repositoryrequired

Whether this is a supported base model or a model repository.

repository_idUUID

Present for repository models. Use this as modelId in model resource routes.

A missing or invalid token returns 401. A token without the required scope returns 403.

Was this page helpful?