fine_tuning_job_idstringrequired
The ID of the fine-tuning job to cancel.
Example:ft-AF1WoRqd3aJAHsqc9NY7iL8F
Immediately cancel a fine-tune job.
post
https://api.openai.com/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel
Path Parameters
Response
200 application/json
Response
200 application/json
OK
FineTuningJob
The fine_tuning.job object represents a fine-tuning job that has been created through the API.
idstringrequired
The object identifier, which can be referenced in the API endpoints.
created_atintegerrequired
The Unix timestamp (in seconds) for when the fine-tuning job was created.
errorobject | nullrequired
For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
Show Child Parameters
fine_tuned_modelstring | nullrequired
The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.
finished_atinteger | nullrequired
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.
hyperparametersobjectrequired
The hyperparameters used for the fine-tuning job. This value will only be returned when running supervised jobs.
Show Child Parameters
modelstringrequired
The base model that is being fine-tuned.
objectstringrequired
The object type, which is always “fine_tuning.job”.
Allowed values:fine_tuning.job
organization_idstringrequired
The organization that owns the fine-tuning job.
result_filesarray[string]required
The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.
Example:file-abc123
statusstringrequired
The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.
Allowed values:validating_filesqueuedrunningsucceededfailedcancelled
trained_tokensinteger | nullrequired
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.
training_filestringrequired
The file ID used for training. You can retrieve the training data with the Files API.
validation_filestring | nullrequired
The file ID used for validation. You can retrieve the validation results with the Files API.
integrations
One Ofarray | null
A list of integrations to enable for this fine-tuning job.
<= 5 items
Fine-Tuning Job Integrationobject
Show Child Parameters
seedintegerrequired
The seed used for the fine-tuning job.
estimated_finishinteger | null
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.
methodobject
The method used for fine-tuning.
Show Child Parameters
post/fine_tuning/jobs/{fine_tuning_job_id}/cancel
Authentication
Path Parameters
200 application/json
List checkpoints for a fine-tuning job.
get
https://api.openai.com/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
Query Parameters
afterstring
Identifier for the last checkpoint ID from the previous pagination request.
limitinteger
Number of checkpoints to retrieve.
Default:10
Path Parameters
fine_tuning_job_idstringrequired
The ID of the fine-tuning job to get checkpoints for.
Example:ft-AF1WoRqd3aJAHsqc9NY7iL8F
Response
200 application/json
Response
200 application/json
OK
ListFineTuningJobCheckpointsResponse
dataarray[object]required
The fine_tuning.job.checkpoint object represents a model checkpoint for a fine-tuning job that is ready to use.
Show Child Parameters
objectstringrequired
Allowed values:list
first_idstring | null
last_idstring | null
has_morebooleanrequired
get/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
Authentication
Path Parameters
Query Parameters
200 application/json
Get status updates for a fine-tuning job.
get
https://api.openai.com/v1/fine_tuning/jobs/{fine_tuning_job_id}/events
Query Parameters
afterstring
Identifier for the last event from the previous pagination request.
limitinteger
Number of events to retrieve.
Default:20
Path Parameters
fine_tuning_job_idstringrequired
The ID of the fine-tuning job to get events for.
Example:ft-AF1WoRqd3aJAHsqc9NY7iL8F
Response
200 application/json
Response
200 application/json
OK
ListFineTuningJobEventsResponse
dataarray[object]required
Fine-tuning job event object
Show Child Parameters
objectstringrequired
Allowed values:list
has_morebooleanrequired
get/fine_tuning/jobs/{fine_tuning_job_id}/events
Authentication
Path Parameters
Query Parameters
200 application/json
Batch
Create large batches of API requests to run asynchronously.
Creates and executes a batch from an uploaded file of requests
post
https://api.openai.com/v1/batches
Body
application/json
Body
application/json
input_file_idstringrequired
The ID of an uploaded file that contains requests for the new batch.
See upload file for how to upload a file.
Your input file must be formatted as a JSONL file, and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 200 MB in size.
endpointstringrequired
The endpoint to be used for all requests in the batch. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.
Allowed values:/v1/chat/completions/v1/embeddings/v1/completions
completion_windowstringrequired
The time frame within which the batch should be processed. Currently only 24h is supported.
Allowed values:24h
metadataobject | null
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
Response
200 application/json
Response
200 application/json
Batch created successfully.
Batch
idstringrequired
objectstringrequired
The object type, which is always batch.
Allowed values:batch
endpointstringrequired
The OpenAI API endpoint used by the batch.
errorsobject
Show Child Parameters
input_file_idstringrequired
The ID of the input file for the batch.
completion_windowstringrequired
The time frame within which the batch should be processed.
statusstringrequired
The current status of the batch.
Allowed values:validatingfailedin_progressfinalizingcompletedexpiredcancellingcancelled
output_file_idstring
The ID of the file containing the outputs of successfully executed requests.
error_file_idstring
The ID of the file containing the outputs of requests with errors.
created_atintegerrequired
The Unix timestamp (in seconds) for when the batch was created.
in_progress_atinteger
The Unix timestamp (in seconds) for when the batch started processing.
expires_atinteger
The Unix timestamp (in seconds) for when the batch will expire.
finalizing_atinteger
The Unix timestamp (in seconds) for when the batch started finalizing.
completed_atinteger
The Unix timestamp (in seconds) for when the batch was completed.
failed_atinteger
The Unix timestamp (in seconds) for when the batch failed.
expired_atinteger
The Unix timestamp (in seconds) for when the batch expired.
cancelling_atinteger
The Unix timestamp (in seconds) for when the batch started cancelling.
cancelled_atinteger
The Unix timestamp (in seconds) for when the batch was cancelled.
request_countsobject
The request counts for different statuses within the batch.
Show Child Parameters
metadataobject | null
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
post/batches
Authentication
Body
{
"input_file_id": "input_file_id",
"endpoint": "/v1/chat/completions",
"completion_window": "24h"
}
200 application/json