Training

Start a training run

Changed on

Start training a custom style/LoRA from a reference set. Returns immediately with a run ID. Poll GET /workspaces/{workspace_id}/training-runs/{training_run_id} for progress. Creative Units are reserved at submission; call the estimate endpoint first to check cost.

post/v2/workspaces/{workspace_id}/training-runs

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v2/workspaces/{workspace_id}/training-runs
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.app.layer.ai/authorize, token URL https://auth.app.layer.ai/oauth/token)
    • OAuth 2 (client credentials, token URL https://api.app.layer.ai/api/oauth/token, scopes: reference_sets:write)

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

Request body

reference_set_idstring uuid required

The reference set (Style) to train a LoRA for.

base_model_idstring nullable

Base model to train. Omit to use the reference set's configured or workspace default model.

training_framework'fal' | 'ai-toolkit' nullable

Training framework override. Omit for the server default.

Response

Successful Response

training_run_idstring uuid required

Unique identifier for this training run.

state'in_progress' | 'terminal_success' | 'terminal_failure' required

Coarse state; in_progress right after submission.

raw_statusstring required

Fine-grained run status (e.g. initializing).

base_model_idstring nullable

Base model the run trains with.

created_atstring date-time required

Timestamp the run was created.

poll_interval_secondsinteger required

Suggested polling interval in seconds.

expected_eventsWebhookEventType[]

Deliveries this run will produce. Empty when no webhook was supplied.

Changes

  • 326f3bcdabccRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 2d86d473cda6Revision changes
    • info

      the endpoint scheme security serviceAccount was added to the API

    • info

      the security scope reference_sets:write was removed from the endpoint's security scheme oauth2