Skip to content
FLORA FLORA API

List available models

GET
/models
 
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);

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

Error responses use the standard error body.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
type

Model type

string
Allowed values: image video audio text model3d

Model type

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Available models returned.

Media type application/json
object
models
required
Array<object>
object
model_id
required

Model identifier

string
>= 1 characters
name
required

Model name

string
type
required

Model type

string
Allowed values: image video audio text model3d
provider
required

Model provider

string
capabilities
required

Model capabilities

Array<string>
estimated_credits
required

Estimated credits (legacy unit). Prefer estimated_cost_usd.

integer
estimated_cost_usd
required

Base price of one generation in USD at default parameters, before parameter surcharges and plan discounts. Quote this to users rather than credits.

number
estimated_seconds
required

Estimated seconds

integer
params
required

Supported generation parameters for this model

Array<object>
object
name
required

Parameter name to pass in generation params

string
type
required

Parameter value type

string
Allowed values: string string[] bool int int? seed float dict
required
required

Whether the model requires this parameter

boolean
default

Default parameter value

min

Minimum numeric value

number
max

Maximum numeric value

number
label

Human-readable parameter label

string
description

Parameter help text

string
options

Allowed values for enum-like parameters

Array<object>
object
label
required

Displayed option label

string
value
required

Option value to pass in generation params

string
description

Option description

string
properties

Nested numeric properties for object parameters

object
key
additional properties
object
min
required
number
max
required
number
default
required
number
beta

Whether this model is in beta

boolean
Example 
{
  "models": [
    {
      "model_id": "t2i-flux-2-pro",
      "type": "image",
      "provider": "Black Forest Labs",
      "params": [
        {
          "type": "string"
        }
      ]
    }
  ]
}