Advance a fine-tuning job
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "succeeded",
"provider_job_id": "ftjob-abc123",
"fine_tuned_model": "ft:gpt-4o-mini:acme::abc123",
"error": "<string>",
"model_display_name": "Support bot v2 (tuned)"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}"
payload = {
"status": "succeeded",
"provider_job_id": "ftjob-abc123",
"fine_tuned_model": "ft:gpt-4o-mini:acme::abc123",
"error": "<string>",
"model_display_name": "Support bot v2 (tuned)"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'succeeded',
provider_job_id: 'ftjob-abc123',
fine_tuned_model: 'ft:gpt-4o-mini:acme::abc123',
error: '<string>',
model_display_name: 'Support bot v2 (tuned)'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}', 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.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'succeeded',
'provider_job_id' => 'ftjob-abc123',
'fine_tuned_model' => 'ft:gpt-4o-mini:acme::abc123',
'error' => '<string>',
'model_display_name' => 'Support bot v2 (tuned)'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}"
payload := strings.NewReader("{\n \"status\": \"succeeded\",\n \"provider_job_id\": \"ftjob-abc123\",\n \"fine_tuned_model\": \"ft:gpt-4o-mini:acme::abc123\",\n \"error\": \"<string>\",\n \"model_display_name\": \"Support bot v2 (tuned)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"succeeded\",\n \"provider_job_id\": \"ftjob-abc123\",\n \"fine_tuned_model\": \"ft:gpt-4o-mini:acme::abc123\",\n \"error\": \"<string>\",\n \"model_display_name\": \"Support bot v2 (tuned)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"succeeded\",\n \"provider_job_id\": \"ftjob-abc123\",\n \"fine_tuned_model\": \"ft:gpt-4o-mini:acme::abc123\",\n \"error\": \"<string>\",\n \"model_display_name\": \"Support bot v2 (tuned)\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agent_id": "<string>",
"job": {
"id": "<string>",
"status": "succeeded",
"fine_tuned_model": "<string>",
"custom_model_id": "<string>"
},
"registered_model": {
"id": "<string>",
"model_name": "<string>",
"display_name": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Agents
Advance a fine-tuning job
Move a fine-tuning job to its next lifecycle state as the external tuning run progresses (queued → running → succeeded/failed/cancelled). Record the upstream provider_job_id, the resulting fine_tuned_model (required to reach succeeded), or an error reason. On success the resulting model is auto-registered into the agent’s custom-model registry — pass model_display_name to label it. Terminal states cannot transition.
PATCH
/
api
/
v1
/
agents
/
{agentId}
/
fine-tuning
/
jobs
/
{jobId}
Advance a fine-tuning job
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "succeeded",
"provider_job_id": "ftjob-abc123",
"fine_tuned_model": "ft:gpt-4o-mini:acme::abc123",
"error": "<string>",
"model_display_name": "Support bot v2 (tuned)"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}"
payload = {
"status": "succeeded",
"provider_job_id": "ftjob-abc123",
"fine_tuned_model": "ft:gpt-4o-mini:acme::abc123",
"error": "<string>",
"model_display_name": "Support bot v2 (tuned)"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'succeeded',
provider_job_id: 'ftjob-abc123',
fine_tuned_model: 'ft:gpt-4o-mini:acme::abc123',
error: '<string>',
model_display_name: 'Support bot v2 (tuned)'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}', 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.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'succeeded',
'provider_job_id' => 'ftjob-abc123',
'fine_tuned_model' => 'ft:gpt-4o-mini:acme::abc123',
'error' => '<string>',
'model_display_name' => 'Support bot v2 (tuned)'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}"
payload := strings.NewReader("{\n \"status\": \"succeeded\",\n \"provider_job_id\": \"ftjob-abc123\",\n \"fine_tuned_model\": \"ft:gpt-4o-mini:acme::abc123\",\n \"error\": \"<string>\",\n \"model_display_name\": \"Support bot v2 (tuned)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"succeeded\",\n \"provider_job_id\": \"ftjob-abc123\",\n \"fine_tuned_model\": \"ft:gpt-4o-mini:acme::abc123\",\n \"error\": \"<string>\",\n \"model_display_name\": \"Support bot v2 (tuned)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/{agentId}/fine-tuning/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"succeeded\",\n \"provider_job_id\": \"ftjob-abc123\",\n \"fine_tuned_model\": \"ft:gpt-4o-mini:acme::abc123\",\n \"error\": \"<string>\",\n \"model_display_name\": \"Support bot v2 (tuned)\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agent_id": "<string>",
"job": {
"id": "<string>",
"status": "succeeded",
"fine_tuned_model": "<string>",
"custom_model_id": "<string>"
},
"registered_model": {
"id": "<string>",
"model_name": "<string>",
"display_name": "<string>"
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Available options:
queued, running, succeeded, failed, cancelled Example:
"succeeded"
Example:
"ftjob-abc123"
Required when transitioning to succeeded.
Example:
"ft:gpt-4o-mini:acme::abc123"
Failure reason when transitioning to failed.
Display name for the custom model auto-registered on success.
Example:
"Support bot v2 (tuned)"
⌘I