> For the complete documentation index, see [llms.txt](https://docs.flora.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flora.ai/api/reference/models/listmodels.md).

# List available models

List available models with the FLORA API: GET /models.

Returns the public model catalog visible to API clients. Use the optional type filter to narrow results to image, video, audio, or text models.

```http
GET https://app.flora.ai/api/v1/models
```

* **Auth:** API key as a bearer token, `Authorization: Bearer $FLORA_API_KEY`. See [Authentication](https://docs.flora.ai/api/platform/authentication.md).
* **TypeScript SDK:** `client.models.list()`.
* **Operation ID:** `listModels`.

## Example

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X GET 'https://app.flora.ai/api/v1/models' \
  -H "Authorization: Bearer $FLORA_API_KEY"
```

{% endtab %}

{% tab title="TypeScript SDK" %}

```typescript
import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

const page = await client.models.list();
console.log(page);
```

{% endtab %}
{% endtabs %}

## Query parameters

| Name   | Type   | Required | Description                                                       |
| ------ | ------ | -------- | ----------------------------------------------------------------- |
| `type` | string | No       | Model type. One of: `image`, `video`, `audio`, `text`, `model3d`. |

## Responses

### 200: Available models returned.

| Field                                        | Type             | Required | Description                                                                                                                                                                                                                 |
| -------------------------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `models`                                     | array of objects | Yes      |                                                                                                                                                                                                                             |
| `models[].model_id`                          | string           | Yes      | Model identifier. At least 1 character. Example: `t2i-flux-2-pro`.                                                                                                                                                          |
| `models[].name`                              | string           | Yes      | Model name                                                                                                                                                                                                                  |
| `models[].type`                              | string           | Yes      | Model type. One of: `image`, `video`, `audio`, `text`, `model3d`.                                                                                                                                                           |
| `models[].provider`                          | string           | Yes      | Model provider. Example: `Black Forest Labs`.                                                                                                                                                                               |
| `models[].capabilities`                      | array of string  | Yes      | Model capabilities                                                                                                                                                                                                          |
| `models[].estimated_credits`                 | integer          | Yes      | Estimated credits (legacy unit). Prefer estimated\_cost\_usd. At least 0.                                                                                                                                                   |
| `models[].estimated_cost_usd`                | number           | Yes      | Base price of one generation in USD at default parameters, before parameter surcharges and plan discounts. Quote this to users rather than credits. At least 0.                                                             |
| `models[].estimated_seconds`                 | integer          | Yes      | Estimated seconds. At least 0.                                                                                                                                                                                              |
| `models[].params`                            | array of objects | Yes      | Supported generation parameters for this model                                                                                                                                                                              |
| `models[].params[].name`                     | string           | Yes      | Parameter name to pass in generation params                                                                                                                                                                                 |
| `models[].params[].type`                     | string           | Yes      | Parameter value type. One of: `string`, `string[]`, `bool`, `int`, `int?`, `seed`, `float`, `dict`.                                                                                                                         |
| `models[].params[].required`                 | boolean          | Yes      | Whether the model requires this parameter                                                                                                                                                                                   |
| `models[].params[].default`                  | any              | No       | Default parameter value                                                                                                                                                                                                     |
| `models[].params[].min`                      | number           | No       | Minimum numeric value                                                                                                                                                                                                       |
| `models[].params[].max`                      | number           | No       | Maximum numeric value                                                                                                                                                                                                       |
| `models[].params[].label`                    | string           | No       | Human-readable parameter label                                                                                                                                                                                              |
| `models[].params[].description`              | string           | No       | Parameter help text                                                                                                                                                                                                         |
| `models[].params[].options`                  | array of objects | No       | Allowed values for enum-like parameters                                                                                                                                                                                     |
| `models[].params[].options[].label`          | string           | Yes      | Displayed option label                                                                                                                                                                                                      |
| `models[].params[].options[].value`          | string           | Yes      | Option value to pass in generation params                                                                                                                                                                                   |
| `models[].params[].options[].description`    | string           | No       | Option description                                                                                                                                                                                                          |
| `models[].params[].properties`               | map of object    | No       | Nested numeric properties for object parameters                                                                                                                                                                             |
| `models[].params[].properties.{key}.min`     | number           | Yes      |                                                                                                                                                                                                                             |
| `models[].params[].properties.{key}.max`     | number           | Yes      |                                                                                                                                                                                                                             |
| `models[].params[].properties.{key}.default` | number           | Yes      |                                                                                                                                                                                                                             |
| `models[].beta`                              | boolean          | No       | Whether this model is in beta                                                                                                                                                                                               |
| `featured`                                   | array of objects | No       | Curated featured models in admin-defined order, always a subset of `models`. Group by `type` for display; each model\_id resolves to the full entry in `models`. Absent on deployments that do not serve featured curation. |
| `featured[].model_id`                        | string           | Yes      | Model identifier. At least 1 character. Example: `t2i-flux-2-pro`.                                                                                                                                                          |
| `featured[].name`                            | string           | Yes      | Model name                                                                                                                                                                                                                  |
| `featured[].type`                            | string           | Yes      | Model type. One of: `image`, `video`, `audio`, `text`, `model3d`.                                                                                                                                                           |

## Errors

Every error has the same body: `error.code`, `error.message`, and `error.fields` on validation errors. See [Errors](https://docs.flora.ai/api/platform/errors.md) for how to recover from each code.

| Status | Code                                         | Meaning                                                                             |
| ------ | -------------------------------------------- | ----------------------------------------------------------------------------------- |
| 400    | `invalid_json`, `input_validation_error`     | The body isn't valid JSON, or an input failed validation (`fields` lists each one). |
| 401    | `unauthorized`, `invalid_api_key`            | The API key is missing, invalid or revoked.                                         |
| 402    | `insufficient_credits`                       | The workspace balance is too low for this request.                                  |
| 403    | `forbidden`, `paid_plan_required`            | The key can't do this, or the workspace plan doesn't include it.                    |
| 404    | `not_found`                                  | The resource doesn't exist or isn't visible to this key.                            |
| 409    | `idempotency_duplicate`, `revision_conflict` | Duplicate `Idempotency-Key` or a stale `base_revision`.                             |
| 429    | `rate_limited`                               | Too many requests. Back off and retry.                                              |
| 500    | `unknown_error`, `internal_error`            | Something failed on FLORA's side. Retry with backoff.                               |
| 503    | `temporarily_unavailable`                    | Authorization is temporarily unavailable. Retry later.                              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flora.ai/api/reference/models/listmodels.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
