create_model

Use create_model to start a new model workspace

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name for the new model. Must be unique within the workspace, URL-safe, and contain only alphanumeric characters, hyphens, and underscores.')]	Yes	—
scaffold	Annotated[bool, Field(description='When true (default), seeds the model with an auto-discovery run.py and a starter financial model. When false, creates a minimal empty model.')]	No	True
description	Annotated[str, Field(description='Optional human-readable description for the model.')]	No	''

Returns

Returns a structured object. Top-level fields:

• model (string)
• description (string)
• run_py (string)
• model_py (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "create_model",
  "arguments": {
    "model_name": "forecasts",
    "scaffold": true,
    "description": "FY26 revenue and cash forecasts"
  }
}

Response

{
  "model": "forecasts",
  "description": "FY26 revenue and cash forecasts",
  "run_py": "# scaffolded run.py content...",
  "model_py": "# scaffolded model/my_model.py content..."
}

Notes

• Module: Models
• Requires authentication via API token or Auth0 JWT.