Create model

Create a private model in a personal or organization workspace. The caller must be allowed to create repositories for workspace.

Include questions to initialize the model's decision criteria at creation. The model is then ready for decisions without a separate update request.

POST/v1/models

Authorization

Authorizationstringrequired

Send a Modaic bearer token in the Authorization header.

Parameters

workspacestringrequired

The workspace slug: your username or organization slug.

slugstringrequired

The model slug. It must start with an alphanumeric character and may contain letters, digits, ., _, and -, up to 100 characters.

descriptionstring

A description up to 1,000 characters.

defaultBranchstringdefault: main

The initial default branch.

modelstringdefault: mo-fast

Root model used for decisions. Defaults to mo-fast when questions is supplied. Supplying model requires questions.

questionsRecord<string, Question>

Initial decision criteria. Question shapes match Create decision. Omit both model and questions to create an unconfigured model.

idUUIDrequired

The modelId used by model-scoped API routes.

workspacestringrequired

The workspace slug, such as acme.

slugstringrequired

descriptionstring | nullrequired

defaultBranchstringrequired

visibilityprivaterequired

Model repositories are private.

createdAtISO 8601 datetimerequired

updatedAtISO 8601 datetimerequired

Use Update model to revise the model's criteria after creation.

Was this page helpful?