Queue a training run
curl --request POST \
--url https://api.example.com/admin/tenants/{tenant_id}/trainimport requests
url = "https://api.example.com/admin/tenants/{tenant_id}/train"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/admin/tenants/{tenant_id}/train', 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/admin/tenants/{tenant_id}/train",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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/admin/tenants/{tenant_id}/train"
req, _ := http.NewRequest("POST", url, nil)
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/admin/tenants/{tenant_id}/train")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/tenants/{tenant_id}/train")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Staff Onboarding
Queue a training run
Requires onboarding_admin + CSRF. Returns 409 if the tenant has no ingested dataset. Enqueues a train_tenant_model platform job keyed by train:{tenant_id}:{dataset_id}:{config_hash} — the config hash covers the embedding/clusterer settings, so a configuration change gets its own job instead of colliding with a prior run’s idempotency key. A previously failed or cancelled job for the same key is automatically retried. Returns 202 with the job id.
POST
/
admin
/
tenants
/
{tenant_id}
/
train
Queue a training run
curl --request POST \
--url https://api.example.com/admin/tenants/{tenant_id}/trainimport requests
url = "https://api.example.com/admin/tenants/{tenant_id}/train"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/admin/tenants/{tenant_id}/train', 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/admin/tenants/{tenant_id}/train",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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/admin/tenants/{tenant_id}/train"
req, _ := http.NewRequest("POST", url, nil)
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/admin/tenants/{tenant_id}/train")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/tenants/{tenant_id}/train")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Response
Successful Response
The response is of type Response Train Admin Tenants Tenant Id Train Post · object.