Skip to main content
POST
/
v1
/
fine-tuning
Create a new fine-tuning job
curl --request POST \
  --url https://api.example.com/v1/fine-tuning \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "base_model_name": "<string>",
  "dataset_name": "<string>",
  "parameters": {
    "batch_size": 8,
    "num_epochs": 3,
    "shuffle": true,
    "lr": 0.0003,
    "seed": 42
  },
  "name": "<string>"
}
'
import requests

url = "https://api.example.com/v1/fine-tuning"

payload = {
"base_model_name": "<string>",
"dataset_name": "<string>",
"parameters": {
"batch_size": 8,
"num_epochs": 3,
"shuffle": True,
"lr": 0.0003,
"seed": 42
},
"name": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
base_model_name: '<string>',
dataset_name: '<string>',
parameters: {batch_size: 8, num_epochs: 3, shuffle: true, lr: 0.0003, seed: 42},
name: '<string>'
})
};

fetch('https://api.example.com/v1/fine-tuning', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'base_model_name' => '<string>',
'dataset_name' => '<string>',
'parameters' => [
'batch_size' => 8,
'num_epochs' => 3,
'shuffle' => true,
'lr' => 0.0003,
'seed' => 42
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/fine-tuning"

payload := strings.NewReader("{\n \"base_model_name\": \"<string>\",\n \"dataset_name\": \"<string>\",\n \"parameters\": {\n \"batch_size\": 8,\n \"num_epochs\": 3,\n \"shuffle\": true,\n \"lr\": 0.0003,\n \"seed\": 42\n },\n \"name\": \"<string>\"\n}")

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

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"base_model_name\": \"<string>\",\n \"dataset_name\": \"<string>\",\n \"parameters\": {\n \"batch_size\": 8,\n \"num_epochs\": 3,\n \"shuffle\": true,\n \"lr\": 0.0003,\n \"seed\": 42\n },\n \"name\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"base_model_name\": \"<string>\",\n \"dataset_name\": \"<string>\",\n \"parameters\": {\n \"batch_size\": 8,\n \"num_epochs\": 3,\n \"shuffle\": true,\n \"lr\": 0.0003,\n \"seed\": 42\n },\n \"name\": \"<string>\"\n}"

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
}
{
"status": 123,
"message": "<string>"
}
{
"status": 123,
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
base_model_name
string
required
dataset_name
string
required
parameters
object
required
name
string
required

The name of the fine-tuning job

type
enum<string>
required

The type of fine-tuning job to run

Available options:
LORA,
QLORA

Response

Created

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