Sign in
gateway.openapi_Gateway

Create Reinforcement Fine-tuning Job

post/v1/accounts/{account_id}/reinforcementFineTuningJobs

Path parameters

account_idstring required

The Account Id

Query parameters

reinforcementFineTuningJobIdstring

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

Request body

namestring
displayNamestring
createTimestring date-time
completedTimestring date-time

The completed time for the reinforcement fine-tuning job.

datasetstring required

The name of the dataset used for training.

evaluationDatasetstring

The name of a separate dataset to use for evaluation.

evalAutoCarveoutboolean

Whether to auto-carve the dataset for eval.

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.

evaluatorstring required

The evaluator resource name to use for RLOR fine-tuning job.

outputStatsstring

The output dataset's aggregated stats for the evaluation job.

chunkSizeinteger

Data chunking for rollout, default size 200, enabled when dataset > 300. Valid range is 1-10,000.

outputMetricsstring
mcpServerstring
maxInferenceReplicaCountinteger
nodeCountinteger

The number of nodes to use for the fine-tuning job. If not specified, the default is 1.

trainerLogsSignedUrlstring

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

acceleratorSecondsobject

Accelerator seconds used by the job, keyed by accelerator type (e.g., "NVIDIA_H100_80GB"). Updated when job completes or is cancelled.

maxConcurrentRolloutsinteger

Maximum number of concurrent rollouts during the RFT job.

maxConcurrentEvaluationsinteger

Maximum number of concurrent evaluations during the RFT job.

Response

A successful response.

namestring
displayNamestring
createTimestring date-time
completedTimestring date-time

The completed time for the reinforcement fine-tuning job.

datasetstring required

The name of the dataset used for training.

evaluationDatasetstring

The name of a separate dataset to use for evaluation.

evalAutoCarveoutboolean

Whether to auto-carve the dataset for eval.

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.

evaluatorstring required

The evaluator resource name to use for RLOR fine-tuning job.

outputStatsstring

The output dataset's aggregated stats for the evaluation job.

chunkSizeinteger

Data chunking for rollout, default size 200, enabled when dataset > 300. Valid range is 1-10,000.

outputMetricsstring
mcpServerstring
maxInferenceReplicaCountinteger
nodeCountinteger

The number of nodes to use for the fine-tuning job. If not specified, the default is 1.

trainerLogsSignedUrlstring

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

acceleratorSecondsobject

Accelerator seconds used by the job, keyed by accelerator type (e.g., "NVIDIA_H100_80GB"). Updated when job completes or is cancelled.

maxConcurrentRolloutsinteger

Maximum number of concurrent rollouts during the RFT job.

maxConcurrentEvaluationsinteger

Maximum number of concurrent evaluations during the RFT job.

Changes

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

  • 407f0a0fd7674See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      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

  • 79bf507c9d101See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 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

  • 80bec85988ad412See the full diff
    • ●

      added the new DPO enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new GSPO_TOKEN enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ORPO enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      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 optional request property

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new DPO enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new GSPO_TOKEN enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new ORPO enum value to the request property /

      request-property-enum-value-added

    • ○

      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

    • ○

      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

  • 9823da16483715See 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

    • ○

      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

  • e5a236c1c49644See the full diff
    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      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

  • 4e1bdf0cae561113See 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 optional request property

      new-optional-request-property

    • ○

      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

    • ○

      added the optional property to the response with the status

      response-optional-property-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

  • 3cece9a35f2613See the full diff
    • ▲

      removed the enum value US_TEXAS_3 of the request property /

      request-property-enum-value-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

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

      response-property-enum-value-removed

  • 4506ec9d12ff13See the full diff
    • ●

      added the new JOB_STATE_PAUSED 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 JOB_STATE_PAUSED 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