Search Modaic documentation

Find a Modaic guide or API reference

Reference›API›models

Get model

Get a model repository that the authenticated caller can access. Inaccessible models return 404 rather than revealing that a private model exists.

GET/v1/entities/{workspace}/models/{model}

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Parameters

workspacestringrequired

User or organization slug.

modelstringrequired

Model repository slug.

Response

idUUIDrequired

The modelId used by examples, batch decisions, alignments, and metrics.

workspaceEntityrequired
slugstringrequired
descriptionstring | nullrequired
defaultBranchstringrequired
visibilityprivaterequired
createdAtISO 8601 datetimerequired
updatedAtISO 8601 datetimerequired
commitobject

The default branch's current head: commitSha, branch, and previousSha (equal to commitSha). Pass commitSha back as expectedHeadSha on an update, sourceCommitSha on an alignment, or the target of a tag.

configurationModelConfiguration

The configuration saved on the default branch: schemaVersion, root model, checkpoint, questions, and any saved metrics or capture policy. Omitted when the model has no model.json yet.

Was this page helpful?