---
title: "models.ready"
slug: "ai-models-ready"
updated: 2025-11-06T19:37:54Z
published: 2025-11-06T19:37:54Z
canonical: "docs.doc-know.com/ai-models-ready"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.doc-know.com/llms.txt
> Use this file to discover all available pages before exploring further.

# models.ready

### ai.models.ready

Returns whether or not a machine learning (ML) model is installed and ready for use. When ready, run your model using [ai.models.run](http://docs.doc-know.com/v1/docs/ai-models-run).

### Input Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| **key** | Text | Yes | Unique model identifier used during [ai.models.install](http://docs.doc-know.com/v1/docs/ai-models-install) |

### Returns

Type: **Boolean**

Returns **true** if model is installed and ready for use. Otherwise, **false** is returned.

### Examples

```
// check if model is installed and ready for use
if (ai.models.ready("riskModel") === true)
    debug.log("Model is ready.");
```

### Remarks

Use this function to check if a machine learning (ML) model is installed and ready for use. For this to return true, you must have previously installed the model using [ai.models.install](http://docs.doc-know.com/v1/docs/ai-models-install).