Skip to content
Lucero

Immediately cancel a fine-tune job.

POST
/fine_tuning/jobs/{fine_tuning_job_id}/cancel

Authorizations

Parameters

Path Parameters

fine_tuning_job_id
required
string
ft-AF1WoRqd3aJAHsqc9NY7iL8F

The ID of the fine-tuning job to cancel.

Responses

200

OK

The fine_tuning.job object represents a fine-tuning job that has been created through the API.

object
id
required

The object identifier, which can be referenced in the API endpoints.

string
created_at
required

The Unix timestamp (in seconds) for when the fine-tuning job was created.

integer
error
required

For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.

object
code
required

A machine-readable error code.

string
message
required

A human-readable error message.

string
param
required

The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.

string
nullable
fine_tuned_model
required

The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.

string
nullable
finished_at
required

The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.

integer
nullable
hyperparameters
required

The hyperparameters used for the fine-tuning job. See the fine-tuning guide for more details.

object
n_epochs
required
One of:
string
Allowed values: auto
model
required

The base model that is being fine-tuned.

string
object
required

The object type, which is always “fine_tuning.job”.

string
Allowed values: fine_tuning.job
organization_id
required

The organization that owns the fine-tuning job.

string
result_files
required

The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.

Array<string>
status
required

The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.

string
Allowed values: validating_files queued running succeeded failed cancelled
trained_tokens
required

The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.

integer
nullable
training_file
required

The file ID used for training. You can retrieve the training data with the Files API.

string
validation_file
required

The file ID used for validation. You can retrieve the validation results with the Files API.

string
nullable
integrations

A list of integrations to enable for this fine-tuning job.

Array
nullable <= 5 items
One of:
object
type
required

The type of the integration being enabled for the fine-tuning job

string
Allowed values: wandb
wandb
required

The settings for your integration with Weights and Biases. This payload specifies the project that metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags to your run, and set a default entity (team, username, etc) to be associated with your run.

object
project
required

The name of the project that the new run will be created under.

string
my-wandb-project
name

A display name to set for the run. If not set, we will use the Job ID as the name.

string
nullable
entity

The entity to use for the run. This allows you to set the team or username of the WandB user that you would like associated with the run. If not set, the default entity for the registered WandB API key is used.

string
nullable
tags

A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some default tags are generated by OpenAI: “openai/finetune”, “openai/{base-model}”, “openai/{ftjob-abcdef}”.

Array<string>
seed
required

The seed used for the fine-tuning job.

integer
estimated_finish

The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.

integer
nullable