Cancel Job

Cancel a currently running fine-tuning job.

POST /fine-tunes/{id}/cancel

Cancel job

cURL

curl --request POST \
  --url https://api.together.xyz/v1/fine-tunes/{id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "training_file": "<string>",
  "validation_file": "<string>",
  "model": "<string>",
  "model_output_name": "<string>",
  "model_output_path": "<string>",
  "trainingfile_numlines": 123,
  "trainingfile_size": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "n_epochs": 123,
  "n_checkpoints": 123,
  "n_evals": 123,
  "batch_size": "max",
  "learning_rate": 123,
  "lr_scheduler": {
    "lr_scheduler_type": "linear",
    "lr_scheduler_args": {
      "min_lr_ratio": 0
    }
  },
  "warmup_ratio": 123,
  "max_grad_norm": 123,
  "weight_decay": 123,
  "eval_steps": 123,
  "train_on_inputs": "auto",
  "training_method": {
    "method": "sft"
  },
  "training_type": {
    "type": "Full"
  },
  "job_id": "<string>",
  "events": [
    {
      "object": "fine-tune-event",
      "created_at": "<string>",
      "message": "<string>",
      "type": "job_pending",
      "param_count": 123,
      "token_count": 123,
      "total_steps": 123,
      "wandb_url": "<string>",
      "step": 123,
      "checkpoint_path": "<string>",
      "model_path": "<string>",
      "training_offset": 123,
      "hash": "<string>",
      "level": null
    }
  ],
  "token_count": 123,
  "param_count": 123,
  "total_price": 123,
  "epochs_completed": 123,
  "queue_depth": 123,
  "wandb_project_name": "<string>",
  "wandb_url": "<string>",
  "from_checkpoint": "<string>"
}

Authorizations

Authorization · string · header · default: default · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Fine-tune ID to cancel. A string that starts with ft-.

Response

200

application/json

Successfully cancelled the fine-tuning job.

id · string<uuid> · required

status · enum<string> · required

Available options: pending, queued, running, compressing, uploading, cancel_requested, cancelled, error, completed

training_file · string

validation_file · string

model · string

model_output_name · string

model_output_path · string

trainingfile_numlines · integer

trainingfile_size · integer

created_at · string

updated_at · string

n_epochs · integer

n_checkpoints · integer

n_evals · integer

batch_size · integer enum<string> · default: max

learning_rate · number

lr_scheduler · object

Show child attributes

warmup_ratio · number

max_grad_norm · number<float>

weight_decay · number<float>

eval_steps · integer

train_on_inputs · boolean enum<string> · default: auto

training_method · object

Option 1

Option 2

Show child attributes

training_type · object

Option 1

Option 2

Show child attributes

job_id · string

events · object[]

Show child attributes

token_count · integer

param_count · integer

total_price · integer

epochs_completed · integer

queue_depth · integer

wandb_project_name · string

wandb_url · string

from_checkpoint · string