POST
/
fine_tuning
/
jobs
/
{fine_tuning_job_id}
/
cancel
curl -X POST https://api.portkey.ai/v1/fine_tuning/jobs/ftjob-abc123/cancel \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY"

{
  "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
}

Authorizations

​
x-portkey-api-key
string
header
required
​
x-portkey-virtual-key
string
header
required

Path Parameters

​
fine_tuning_job_id
string
required

The ID of the fine-tuning job to cancel.

Example:

"ft-AF1WoRqd3aJAHsqc9NY7iL8F"

Response

200 - application/json
OK

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

​
id
string
required

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

​
created_at
integer
required

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

​
error
object | null
required

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

​
fine_tuned_model
string | null
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.

​
finished_at
integer | null
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.

​
hyperparameters
object
required

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

​
model
string
required

The base model that is being fine-tuned.

​
object
enum<string>
required

The object type, which is always "fine_tuning.job".

Available options:
fine_tuning.job
​
organization_id
string
required

The organization that owns the fine-tuning job.

​
result_files
string[]
required

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

​
status
enum<string>
required

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

Available options:
validating_files,
queued,
running,
succeeded,
failed,
cancelled
​
trained_tokens
integer | null
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.

​
training_file
string
required

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

​
validation_file
string | null
required

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

​
seed
integer
required

The seed used for the fine-tuning job.

​
integrations
object[] | null

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

​
estimated_finish
integer | 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.

Was this page helpful?

Suggest editsRaise issue