Fine Tuning

fine_tuning

fine_tuning.jobs

Methods

Cancel Fine Tuning ->
post/fine_tuning/jobs/{fine_tuning_job_id}/cancel

Immediately cancel a fine-tune job.

Create Fine Tuning Job ->
post/fine_tuning/jobs

Creates a fine-tuning job which begins the process of creating a new model from a given dataset.

Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

Learn more about fine-tuning

Security
Bearer Auth

Example: Authorization: Bearer My API Key

Body parameters
model: string | "babbage-002" | "davinci-002" | "gpt-3.5-turbo" | 1 more...

The name of the model to fine-tune. You can select one of the supported models.

training_file: string

The ID of an uploaded file that contains training data.

See upload file for how to upload a file.

Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune.

The contents of the file should differ depending on if the model uses the chat or completions format.

See the fine-tuning guide for more details.

hyperparameters?: { batch_size, learning_rate_multiplier, n_epochs }

The hyperparameters used for the fine-tuning job.

integrations?: Array<{ type, wandb }>

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

seed?: number

The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.

suffix?: string

A string of up to 64 characters that will be added to your fine-tuned model name.

For example, a suffix of "custom-model-name" would produce a model name like ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.

validation_file?: string

The ID of an uploaded file that contains validation data.

If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.

Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.

See the fine-tuning guide for more details.

Response fields
Request example
200Example
List Fine Tuning Jobs -> CursorPage<>
get/fine_tuning/jobs

List your organization's fine-tuning jobs

List Fine Tuning Events -> CursorPage<>
get/fine_tuning/jobs/{fine_tuning_job_id}/events

Get status updates for a fine-tuning job.

Retrieve Fine Tuning Job ->
get/fine_tuning/jobs/{fine_tuning_job_id}

Get info about a fine-tuning job.

Learn more about fine-tuning

Domain types

FineTuningJob = { id, created_at, error, 14 more... }
FineTuningJobEvent = { id, created_at, level, 2 more... }
FineTuningJobWandbIntegrationObject = { type, wandb }
FineTuningJobWandbIntegration = { project, entity, name, 1 more... }
FineTuningJobWandbIntegrationObject = { type, wandb }
Fine TuningJobs

Checkpoints

fine_tuning.jobs.checkpoints

Methods

List Fine Tuning Checkpoints -> CursorPage<>
get/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

List checkpoints for a fine-tuning job.

Domain types

FineTuningJobCheckpoint = { id, created_at, fine_tuned_model_checkpoint, 4 more... }