Skip to main content
POST
/
v1
/
fine-tuning
/
{job_name}
/
cancel
Cancel a fine-tuning job
curl --request POST \
  --url https://api.example.com/v1/fine-tuning/{job_name}/cancel \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.example.com/v1/fine-tuning/{job_name}/cancel"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.example.com/v1/fine-tuning/{job_name}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/fine-tuning/{job_name}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/fine-tuning/{job_name}/cancel"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/fine-tuning/{job_name}/cancel")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/fine-tuning/{job_name}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "base_model_name": "<string>",
  "dataset_name": "<string>",
  "name": "<string>",
  "current_step": 123,
  "total_steps": 123,
  "current_epoch": 123,
  "total_epochs": 123,
  "num_tokens": 123,
  "parameters": {
    "batch_size": 8,
    "num_epochs": 3,
    "shuffle": true,
    "lr": 0.0003,
    "seed": 42
  },
  "metrics": {}
}
{
"status": 123,
"message": "<string>"
}
{
"status": 123,
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

job_name
string
required

Response

Job cancelled successfully

id
string<uuid>
created_at
string<date-time>
updated_at
string<date-time>
status
enum<string>
Available options:
NEW,
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPING,
STOPPED
base_model_name
string
dataset_name
string
name
string
type
enum<string>
Available options:
LORA,
QLORA
current_step
integer
total_steps
integer
current_epoch
integer
total_epochs
integer
num_tokens
integer

Number of tokens processed in the fine-tuning job

parameters
object
metrics
object