Skip to content
Agents
Models

Get Model

GET
/v1/models/{model_id}
curl --request GET \
--url https://agents.lumalabs.ai/v1/models/example \
--header 'Authorization: Bearer <token>'

One model row, addressed by model id or public brand alias.

model_id
required
Model Id
string

Successful Response

Media typeapplication/json
Model

A public model id and everything an SDK caller needs to plan against it.

object
actions
Actions
Array<object>
ActionCapabilities

One registry action exposed under a model row.

object
action_id
required
Action Id
string
capabilities
required
ModelCapabilities

What one action — or the union of a model's create actions — can produce.

object
aspect_ratios
Aspect Ratios
Array<string>
audio
Audio
boolean
custom_dimensions
Custom Dimensions
boolean
durations_s
Any of:
DurationSupport

Durations one action accepts — a continuous slider or a fixed picker.

object
max
Any of:
number
min
Any of:
number
step
Any of:
number
values
Any of:
Array<number>
end_frame
End Frame
boolean
max_references
Any of:
integer
output_type
OutputType

Media type an action produces.

string
default: image
Allowed values: image video audio text
references_with_start_frame
Any of:
boolean
resolutions
Resolutions
Array<string>
seed
Seed
boolean
start_frame
Start Frame
boolean
voices
Any of:
Array<string>
kind
required
ActionKind

Public name for what one action does to media.

string
Allowed values: create edit extend reframe stitch mux tts music sfx lipsync stems isolation transcribe layering
pricing
Any of:
ModelPricing

Credit rates keyed by pricing variant, from the action's pricing schema.

object
credits
Credits

Credits per unit, keyed by variant (such as a resolution, or key=value pairs joined by |); default when there is one rate.

object
key
additional properties
integer
currency
Currency
string
default: credits
estimate
Estimate

True when the charge settles on what the run used (such as tokens), so these credits are an estimate and the charge can differ.

boolean
unit
required
Unit

What one rate is charged per, named for what it counts: such as flat for one output, per_second for each second of output duration, or per_megapixel_second for output area times duration.

string
aliases
Aliases
Array<string>
availability
ModelAvailability

Whether the caller may run the model right now.

string
default: available
Allowed values: available requires_upgrade disabled
capabilities
required
ModelCapabilities

What one action — or the union of a model's create actions — can produce.

object
aspect_ratios
Aspect Ratios
Array<string>
audio
Audio
boolean
custom_dimensions
Custom Dimensions
boolean
durations_s
Any of:
DurationSupport

Durations one action accepts — a continuous slider or a fixed picker.

object
max
Any of:
number
min
Any of:
number
step
Any of:
number
values
Any of:
Array<number>
end_frame
End Frame
boolean
max_references
Any of:
integer
output_type
OutputType

Media type an action produces.

string
default: image
Allowed values: image video audio text
references_with_start_frame
Any of:
boolean
resolutions
Resolutions
Array<string>
seed
Seed
boolean
start_frame
Start Frame
boolean
voices
Any of:
Array<string>
id
required
Id
string
modality
required
Modality

What a model row is for, in the vocabulary the SDK contract publishes.

string
Allowed values: image video audio edit utility
pricing
Any of:
ModelPricing

Credit rates keyed by pricing variant, from the action's pricing schema.

object
credits
Credits

Credits per unit, keyed by variant (such as a resolution, or key=value pairs joined by |); default when there is one rate.

object
key
additional properties
integer
currency
Currency
string
default: credits
estimate
Estimate

True when the charge settles on what the run used (such as tokens), so these credits are an estimate and the charge can differ.

boolean
unit
required
Unit

What one rate is charged per, named for what it counts: such as flat for one output, per_second for each second of output duration, or per_megapixel_second for output area times duration.

string
Example
{
"actions": [
{
"capabilities": {
"audio": false,
"custom_dimensions": false,
"end_frame": false,
"output_type": "image",
"seed": false,
"start_frame": false
},
"kind": "create",
"pricing": {
"currency": "credits",
"estimate": false
}
}
],
"availability": "available",
"capabilities": {
"audio": false,
"custom_dimensions": false,
"end_frame": false,
"output_type": "image",
"seed": false,
"start_frame": false
},
"modality": "image",
"pricing": {
"currency": "credits",
"estimate": false
}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}