Sign in
gateway.openapi_Gateway

Create Supervised Fine-tuning Job

post/v1/accounts/{account_id}/supervisedFineTuningJobs

Path parameters

account_idstring required

The Account Id

Query parameters

supervisedFineTuningJobIdstring

ID of the supervised fine-tuning job, a random UUID will be generated if not specified.

Request body

namestring
displayNamestring
createTimestring date-time
completedTimestring date-time
datasetstring required

The name of the dataset used for training.

state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_CREATING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_COMPLETED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_DELETING' | 'JOB_STATE_WRITING_RESULTS' | 'JOB_STATE_VALIDATING' | 'JOB_STATE_DELETING_CLEANING_UP' | 'JOB_STATE_PENDING' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_RE_QUEUEING' | 'JOB_STATE_CREATING_INPUT_DATASET' | 'JOB_STATE_IDLE' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_EARLY_STOPPED' | 'JOB_STATE_PAUSED'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
createdBystring

The email address of the user who initiated this fine-tuning job.

outputModelstring

The model ID to be assigned to the resulting fine-tuned model. If not specified, the job ID will be used.

baseModelstring

The name of the base model to be fine-tuned Only one of 'base_model' or 'warm_start_from' should be specified.

warmStartFromstring

The PEFT addon model in Fireworks format to be fine-tuned from Only one of 'base_model' or 'warm_start_from' should be specified.

jinjaTemplatestring
earlyStopboolean

Whether to stop training early if the validation loss does not improve.

epochsinteger

The number of epochs to train for.

learningRatenumber float

The learning rate used for training.

maxContextLengthinteger

The maximum context length to use with the model.

loraRankinteger

The rank of the LoRA layers.

evaluationDatasetstring

The name of a separate dataset to use for evaluation.

isTurboboolean

Whether to run the fine-tuning job in turbo mode.

evalAutoCarveoutboolean

Whether to auto-carve the dataset for eval.

region'REGION_UNSPECIFIED' | 'US_IOWA_1' | 'US_VIRGINIA_1' | 'US_VIRGINIA_2' | 'US_ILLINOIS_1' | 'AP_TOKYO_1' | 'EU_LONDON_1' | 'US_ARIZONA_1' | 'US_TEXAS_1' | 'US_ILLINOIS_2' | 'EU_FRANKFURT_1' | 'US_TEXAS_2' | 'EU_PARIS_1' | 'EU_HELSINKI_1' | 'US_NEVADA_1' | 'EU_ICELAND_1' | 'EU_ICELAND_2' | 'US_WASHINGTON_1' | 'US_WASHINGTON_2' | 'EU_ICELAND_DEV_1' | 'US_WASHINGTON_3' | 'US_ARIZONA_2' | 'AP_TOKYO_2' | 'US_CALIFORNIA_1' | 'US_MISSOURI_1' | 'US_UTAH_1' | 'US_TEXAS_3' | 'US_ARIZONA_3' | 'US_GEORGIA_1' | 'US_GEORGIA_2' | 'US_WASHINGTON_4' | 'US_GEORGIA_3' | 'NA_BRITISHCOLUMBIA_1' | 'US_GEORGIA_4' | 'EU_ICELAND_3' | 'US_OHIO_1' | 'US_NEWYORK_1'
  • US_IOWA_1: GCP us-central1 (Iowa)
  • US_VIRGINIA_1: AWS us-east-1 (N. Virginia)
  • US_VIRGINIA_2: OCI us-ashburn-1 [HIDE_FROM_DOCS]
  • US_ILLINOIS_1: OCI us-chicago-1
  • AP_TOKYO_1: OCI ap-tokyo-1
  • EU_LONDON_1: OCI uk-london-1 [HIDE_FROM_DOCS]
  • US_ARIZONA_1: OCI us-phoenix-1
  • US_TEXAS_1: Lambda us-south-3 (C. Texas)
  • US_ILLINOIS_2: Lambda us-midwest-1 (Illinois)
  • EU_FRANKFURT_1: OCI eu-frankfurt-1
  • US_TEXAS_2: Lambda us-south-2 (N. Texas)
  • EU_PARIS_1: Nebius eu-west1 [HIDE_FROM_DOCS]
  • EU_HELSINKI_1: Nebius eu-north1 [HIDE_FROM_DOCS]
  • US_NEVADA_1: GCP us-west4 [HIDE_FROM_DOCS]
  • EU_ICELAND_1: Crusoe eu-iceland1
  • EU_ICELAND_2: Crusoe eu-iceland1 (network1)
  • US_WASHINGTON_1: Voltage Park us-pyl-1 (Detach audio cluster from control_plane)
  • US_WASHINGTON_2: Voltage Park us-seattle-2
  • EU_ICELAND_DEV_1: Crusoe eu-iceland1 (dev) [HIDE_FROM_DOCS]
  • US_WASHINGTON_3: Vultr Seattle 1
  • US_ARIZONA_2: Azure westus3 (Anysphere BYOC) [HIDE_FROM_DOCS]
  • AP_TOKYO_2: AWS ap-northeast-1
  • US_CALIFORNIA_1: AWS us-west-1 (N. California)
  • US_MISSOURI_1: Nebius us-central1 (Anysphere BYOC) [HIDE_FROM_DOCS]
  • US_UTAH_1: GCP us-west3 (Utah)
  • US_TEXAS_3: Crusoe us-southcentral1 [HIDE_FROM_DOCS]
  • US_ARIZONA_3: Coreweave us-west-04a-1 [HIDE_FROM_DOCS]
  • US_GEORGIA_1: DigitalOcean us-atl1
  • US_GEORGIA_2: Vultr Atlanta 1
  • US_WASHINGTON_4: Coreweave us-west-09b-1
  • US_GEORGIA_3: Alicloud us-southeast-1
  • NA_BRITISHCOLUMBIA_1: Fluidstack ca-west-1
  • US_GEORGIA_4: DigitalOcean us-atl1 MI350X
  • EU_ICELAND_3: Crusoe eu-iceland1 (Anysphere BYOC) [HIDE_FROM_DOCS]
  • US_OHIO_1: Lambda us-midwest-2 (Ohio)
  • US_NEWYORK_1: DigitalOcean nyc2
updateTimestring date-time

The update time for the supervised fine-tuning job.

nodesinteger

The number of nodes to use for the fine-tuning job.

batchSizeinteger
mtpEnabledboolean
mtpNumDraftTokensinteger
mtpFreezeBaseModelboolean
metricsFileSignedUrlstring
trainerLogsSignedUrlstring

The signed URL for the trainer logs file (stdout/stderr). Only populated if the account has trainer log reading enabled.

gradientAccumulationStepsinteger
learningRateWarmupStepsinteger
batchSizeSamplesinteger

The number of samples per gradient batch.

optimizerWeightDecaynumber float

Weight decay (L2 regularization) for optimizer.

usePurposestring

Use dedicated resources for the job. The only supported value currently is "pilot". Defaults to empty.

Response

A successful response.

namestring
displayNamestring
createTimestring date-time
completedTimestring date-time
datasetstring required

The name of the dataset used for training.

state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_CREATING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_COMPLETED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_DELETING' | 'JOB_STATE_WRITING_RESULTS' | 'JOB_STATE_VALIDATING' | 'JOB_STATE_DELETING_CLEANING_UP' | 'JOB_STATE_PENDING' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_RE_QUEUEING' | 'JOB_STATE_CREATING_INPUT_DATASET' | 'JOB_STATE_IDLE' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_EARLY_STOPPED' | 'JOB_STATE_PAUSED'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
createdBystring

The email address of the user who initiated this fine-tuning job.

outputModelstring

The model ID to be assigned to the resulting fine-tuned model. If not specified, the job ID will be used.

baseModelstring

The name of the base model to be fine-tuned Only one of 'base_model' or 'warm_start_from' should be specified.

warmStartFromstring

The PEFT addon model in Fireworks format to be fine-tuned from Only one of 'base_model' or 'warm_start_from' should be specified.

jinjaTemplatestring
earlyStopboolean

Whether to stop training early if the validation loss does not improve.

epochsinteger

The number of epochs to train for.

learningRatenumber float

The learning rate used for training.

maxContextLengthinteger

The maximum context length to use with the model.

loraRankinteger

The rank of the LoRA layers.

evaluationDatasetstring

The name of a separate dataset to use for evaluation.

isTurboboolean

Whether to run the fine-tuning job in turbo mode.

evalAutoCarveoutboolean

Whether to auto-carve the dataset for eval.

region'REGION_UNSPECIFIED' | 'US_IOWA_1' | 'US_VIRGINIA_1' | 'US_VIRGINIA_2' | 'US_ILLINOIS_1' | 'AP_TOKYO_1' | 'EU_LONDON_1' | 'US_ARIZONA_1' | 'US_TEXAS_1' | 'US_ILLINOIS_2' | 'EU_FRANKFURT_1' | 'US_TEXAS_2' | 'EU_PARIS_1' | 'EU_HELSINKI_1' | 'US_NEVADA_1' | 'EU_ICELAND_1' | 'EU_ICELAND_2' | 'US_WASHINGTON_1' | 'US_WASHINGTON_2' | 'EU_ICELAND_DEV_1' | 'US_WASHINGTON_3' | 'US_ARIZONA_2' | 'AP_TOKYO_2' | 'US_CALIFORNIA_1' | 'US_MISSOURI_1' | 'US_UTAH_1' | 'US_TEXAS_3' | 'US_ARIZONA_3' | 'US_GEORGIA_1' | 'US_GEORGIA_2' | 'US_WASHINGTON_4' | 'US_GEORGIA_3' | 'NA_BRITISHCOLUMBIA_1' | 'US_GEORGIA_4' | 'EU_ICELAND_3' | 'US_OHIO_1' | 'US_NEWYORK_1'
  • US_IOWA_1: GCP us-central1 (Iowa)
  • US_VIRGINIA_1: AWS us-east-1 (N. Virginia)
  • US_VIRGINIA_2: OCI us-ashburn-1 [HIDE_FROM_DOCS]
  • US_ILLINOIS_1: OCI us-chicago-1
  • AP_TOKYO_1: OCI ap-tokyo-1
  • EU_LONDON_1: OCI uk-london-1 [HIDE_FROM_DOCS]
  • US_ARIZONA_1: OCI us-phoenix-1
  • US_TEXAS_1: Lambda us-south-3 (C. Texas)
  • US_ILLINOIS_2: Lambda us-midwest-1 (Illinois)
  • EU_FRANKFURT_1: OCI eu-frankfurt-1
  • US_TEXAS_2: Lambda us-south-2 (N. Texas)
  • EU_PARIS_1: Nebius eu-west1 [HIDE_FROM_DOCS]
  • EU_HELSINKI_1: Nebius eu-north1 [HIDE_FROM_DOCS]
  • US_NEVADA_1: GCP us-west4 [HIDE_FROM_DOCS]
  • EU_ICELAND_1: Crusoe eu-iceland1
  • EU_ICELAND_2: Crusoe eu-iceland1 (network1)
  • US_WASHINGTON_1: Voltage Park us-pyl-1 (Detach audio cluster from control_plane)
  • US_WASHINGTON_2: Voltage Park us-seattle-2
  • EU_ICELAND_DEV_1: Crusoe eu-iceland1 (dev) [HIDE_FROM_DOCS]
  • US_WASHINGTON_3: Vultr Seattle 1
  • US_ARIZONA_2: Azure westus3 (Anysphere BYOC) [HIDE_FROM_DOCS]
  • AP_TOKYO_2: AWS ap-northeast-1
  • US_CALIFORNIA_1: AWS us-west-1 (N. California)
  • US_MISSOURI_1: Nebius us-central1 (Anysphere BYOC) [HIDE_FROM_DOCS]
  • US_UTAH_1: GCP us-west3 (Utah)
  • US_TEXAS_3: Crusoe us-southcentral1 [HIDE_FROM_DOCS]
  • US_ARIZONA_3: Coreweave us-west-04a-1 [HIDE_FROM_DOCS]
  • US_GEORGIA_1: DigitalOcean us-atl1
  • US_GEORGIA_2: Vultr Atlanta 1
  • US_WASHINGTON_4: Coreweave us-west-09b-1
  • US_GEORGIA_3: Alicloud us-southeast-1
  • NA_BRITISHCOLUMBIA_1: Fluidstack ca-west-1
  • US_GEORGIA_4: DigitalOcean us-atl1 MI350X
  • EU_ICELAND_3: Crusoe eu-iceland1 (Anysphere BYOC) [HIDE_FROM_DOCS]
  • US_OHIO_1: Lambda us-midwest-2 (Ohio)
  • US_NEWYORK_1: DigitalOcean nyc2
updateTimestring date-time

The update time for the supervised fine-tuning job.

nodesinteger

The number of nodes to use for the fine-tuning job.

batchSizeinteger
mtpEnabledboolean
mtpNumDraftTokensinteger
mtpFreezeBaseModelboolean
metricsFileSignedUrlstring
trainerLogsSignedUrlstring

The signed URL for the trainer logs file (stdout/stderr). Only populated if the account has trainer log reading enabled.

gradientAccumulationStepsinteger
learningRateWarmupStepsinteger
batchSizeSamplesinteger

The number of samples per gradient batch.

optimizerWeightDecaynumber float

Weight decay (L2 regularization) for optimizer.

usePurposestring

Use dedicated resources for the job. The only supported value currently is "pilot". Defaults to empty.

Changes

Changed in 13 of the 27 revisions of this API.12437

  • 407f0a0fd7672See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 79bf507c9d101See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • a1b77ea182882See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c3ed322dd5211See the full diff
    • ●

      added the new US_NEWYORK_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new US_NEWYORK_1 enum value to the request property

      request-property-enum-value-added

  • 920bcfb416a72See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 80bec85988ad15See the full diff
    • ●

      added the new US_OHIO_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new US_OHIO_1 enum value to the request property

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 9823da16483714See the full diff
    • ●

      added the new EU_ICELAND_3 enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new EU_ICELAND_3 enum value to the request property

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4e1bdf0cae561111See the full diff
    • ●

      added the new EU_HELSINKI_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new EU_ICELAND_DEV_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new EU_LONDON_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new EU_PARIS_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_ARIZONA_2 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_ARIZONA_3 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_GEORGIA_4 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_MISSOURI_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_NEVADA_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_TEXAS_3 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new US_VIRGINIA_2 enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new EU_HELSINKI_1 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new EU_ICELAND_DEV_1 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new EU_LONDON_1 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new EU_PARIS_1 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new US_ARIZONA_2 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new US_ARIZONA_3 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new US_GEORGIA_4 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new US_MISSOURI_1 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new US_NEVADA_1 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new US_TEXAS_3 enum value to the request property

      request-property-enum-value-added

    • ○

      added the new US_VIRGINIA_2 enum value to the request property

      request-property-enum-value-added

  • f76a6182f2d511See the full diff
    • ●

      added the new NA_BRITISHCOLUMBIA_1 enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new NA_BRITISHCOLUMBIA_1 enum value to the request property

      request-property-enum-value-added

  • 3cece9a35f26121See the full diff
    • ▲

      removed the enum value US_TEXAS_3 of the request property

      request-property-enum-value-removed

    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      removed the US_TEXAS_3 enum value from the response property for the response status

      response-property-enum-value-removed