API Reference

Train a Custom Element

post
https://cloud.leonardo.ai/api/rest/v1/elements

This endpoint will train a new custom element.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Query parameters to be provided in the request body as a JSON object.

string
required
Defaults to placeholder

The name of the element.

string | null

The description of the element.

string
required

The ID of the dataset to train the element on.

string | null

Use a word that is closely related to what you're training that isn't too common. For example, instead of 'dog,' try something unique like 'jackthedog' or 'magicdonut'. Required for all non-FLUX_DEV models and FLUX_DEV Character model training.

string
required

The category determines how the element will be trained. Options are 'General' | 'Character' | 'Style' | 'Object'. FLUX_DEV doesn't support General category.

boolean
required
Defaults to true

Whether or not encode the train text.

integer | null
Defaults to 1024

The resolution for training. Must be 1024.

enum
required
Defaults to FLUX_DEV

The base version to use if not using a custom model.

integer
required

The number of times the entire training dataset is passed through the element.

Model TypeLora FocusMinMaxDefault
DefaultGeneral | Style | Character | Object1250100
FLUX_DEVStyle3012060
Object120220140
Character100200135
GeneralNA

number
required

The speed at which the model learns during training.

Model TypeLora FocusMinMaxDefault
DefaultGeneral | Style | Character | Object0.000000010.000010.000001
FLUX_DEVStyle0.0000010.000030.00001
Object0.000010.0010.0004
Character0.000010.0010.0005
GeneralNA

Response

Updated 7 months ago

Language
Credentials
Bearer
auth-scheme
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago