Search Modaic documentation

Find a Modaic guide or API reference

ReferenceAPImodels

Update model

Update model metadata or commit a new model.json configuration. Repository write access is required.

PATCH/v1/models/{modelId}

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Parameters

modelIdUUIDrequired

Model repository ID.

branchstring

Branch to update. Defaults to the model's default branch.

descriptionstring | null

Replace or clear the repository description. Requires repository admin access.

modelstring

Root model used for decisions.

questionsRecord<string, Question>

Replace the model's typed questions. Question shapes match POST /v1/decision.

messagestring

Commit message, up to 500 characters, for a configuration change.

At least one field must produce a change. Updating model or questions resets the checkpoint to 0 and clears prior evaluation metrics, while preserving the confidence threshold and capture policy.

Response

idUUIDrequired
ownerEntityrequired
slugstringrequired
descriptionstring | nullrequired
defaultBranchstringrequired
visibilityprivaterequired
configurationModelConfiguration

The current schemaVersion, root model, checkpoint, questions, and any saved metrics or capture policy.

commitobject

Present when the configuration changed. Includes commitSha, branch, and previousSha.

A missing model or branch returns 404. If the branch advances while the update is being committed, the endpoint returns 409.

Was this page helpful?