# `Minga.Extension.ModelRoutes`
[🔗](https://github.com/jsmestad/minga/blob/main/sdk/lib/minga/extension/model_routes.ex#L1)

Registers model routes that run inside Minga's agent loop.

Call `register/2` from your extension's `init/1` and keep the returned reporter. `report_status/2` works from any process.

This is a compile-time stub. At runtime, the real module in Minga's BEAM VM provides the implementation.

# `register_error`

```elixir
@type register_error() ::
  :no_extension_context
  | {:duplicate_route_id, String.t(), term(), term()}
  | {:invalid_spec, atom()}
  | {:invalid_route_module, module()}
  | {:invalid_models, term()}
```

# `report_error`

```elixir
@type report_error() :: :unknown_route | :stale_reporter | :invalid_status
```

# `register`

```elixir
@spec register(map() | keyword(), keyword()) ::
  {:ok, MingaAgent.InferenceRoute.Reporter.t()} | {:error, register_error()}
```

# `report_status`

```elixir
@spec report_status(MingaAgent.InferenceRoute.Reporter.t(), term(), keyword()) ::
  :ok | {:error, report_error()}
```

# `report_usage`

```elixir
@spec report_usage(
  MingaAgent.InferenceRoute.Reporter.t(),
  [MingaAgent.InferenceRoute.PlanWindow.t() | map()],
  keyword()
) :: :ok | {:error, report_error() | {:invalid_plan_window, atom()}}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*
