Skip to main content
POST
Train a custom style (LoRA)
Trained styles are private and only usable by the API user that created them. To allow other workspace members to use the style, share it with the workspace using POST /styles/{id}/share/workspace.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Webhook-URL
string<uri>

URL to receive a POST request when the job completes. The webhook will receive the job data including results.

Body

application/json
name
string
required
urls
string<uri>[]
required

Can be an external URL, base64 data URI, or uploaded asset URL.

Maximum string length: 1024
model
enum<string>
default:flux_dev
Available options:
flux_dev,
flux_schnell,
wan,
wan22
type
enum<string>
default:Default
Available options:
Style,
Object,
Character,
Default
trigger_word
string
learning_rate
number
max_train_steps
integer
Required range: 1 <= x <= 2000
batch_size
integer
Required range: 1 <= x <= 9007199254740991

Response

Training job created successfully. The job will be in a pending state until completed. Use /jobs/{id} to check progress.

job_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
backlogged,
queued,
scheduled,
processing,
sampling,
intermediate-complete,
completed,
failed,
cancelled
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completed_at
null
required
result
null
required
error
object