API Reference
- Introduction
- Authentication
- Headers
- Errors
- Supported Providers
- SDKs
- API Details
Chat Completions
Portkey Endpoints
Embeddings
Other APIs
Completions
Moderations
Fine-tuning
Assistants
- Assistants
- Threads
- Messages
- Runs
- Run Steps
List Fine-tuning Jobs
curl https://api.portkey.ai/v1/fine_tuning/jobs?limit=2 \
-H "x-portkey-api-key: $PORTKEY_API_KEY" \
-H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY"
{
"data": [
{
"id": "<string>",
"created_at": 123,
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"fine_tuned_model": "<string>",
"finished_at": 123,
"hyperparameters": {
"n_epochs": "auto"
},
"model": "<string>",
"object": "fine_tuning.job",
"organization_id": "<string>",
"result_files": [
"file-abc123"
],
"status": "validating_files",
"trained_tokens": 123,
"training_file": "<string>",
"validation_file": "<string>",
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "my-wandb-project",
"name": "<string>",
"entity": "<string>",
"tags": [
"custom-tag"
]
}
}
],
"seed": 123,
"estimated_finish": 123
}
],
"has_more": true,
"object": "list"
}Query Parameters
Identifier for the last job from the previous pagination request.
Number of fine-tuning jobs to retrieve.
Response
The fine_tuning.job object represents a fine-tuning job that has been created through the API.
The object identifier, which can be referenced in the API endpoints.
The Unix timestamp (in seconds) for when the fine-tuning job was created.
For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
A machine-readable error code.
A human-readable error message.
The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.
The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.
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.
The hyperparameters used for the fine-tuning job. See the fine-tuning guide for more details.
The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. "auto" decides the optimal number of epochs based on the size of the dataset. If setting the number manually, we support any number between 1 and 50 epochs.
auto The base model that is being fine-tuned.
The object type, which is always "fine_tuning.job".
fine_tuning.job The organization that owns the fine-tuning job.
The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.
The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.
validating_files, queued, running, succeeded, failed, cancelled 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.
The file ID used for training. You can retrieve the training data with the Files API.
The file ID used for validation. You can retrieve the validation results with the Files API.
The seed used for the fine-tuning job.
A list of integrations to enable for this fine-tuning job.
The type of the integration being enabled for the fine-tuning job
wandb 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.
The name of the project that the new run will be created under.
"my-wandb-project"
A display name to set for the run. If not set, we will use the Job ID as the name.
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.
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}".
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.
list Was this page helpful?
curl https://api.portkey.ai/v1/fine_tuning/jobs?limit=2 \
-H "x-portkey-api-key: $PORTKEY_API_KEY" \
-H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY"
{
"data": [
{
"id": "<string>",
"created_at": 123,
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"fine_tuned_model": "<string>",
"finished_at": 123,
"hyperparameters": {
"n_epochs": "auto"
},
"model": "<string>",
"object": "fine_tuning.job",
"organization_id": "<string>",
"result_files": [
"file-abc123"
],
"status": "validating_files",
"trained_tokens": 123,
"training_file": "<string>",
"validation_file": "<string>",
"integrations": [
{
"type": "wandb",
"wandb": {
"project": "my-wandb-project",
"name": "<string>",
"entity": "<string>",
"tags": [
"custom-tag"
]
}
}
],
"seed": 123,
"estimated_finish": 123
}
],
"has_more": true,
"object": "list"
}