Retrain Model

Retrain an existing model with new data, creating a new version.

POST /models/{model_id}/retrain

Retrain Model

cURL

curl --request POST \
  --url https://api.woodwide.ai/models/{model_id}/retrain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset_id": "a1b2c3d4-0000-0000-0000-000000000001"
}
'

import requests

url = "https://api.woodwide.ai/models/{model_id}/retrain"

payload = { "dataset_id": "a1b2c3d4-0000-0000-0000-000000000001" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dataset_id: 'a1b2c3d4-0000-0000-0000-000000000001'})
};

fetch('https://api.woodwide.ai/models/{model_id}/retrain', 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.woodwide.ai/models/{model_id}/retrain",
  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([
    'dataset_id' => 'a1b2c3d4-0000-0000-0000-000000000001'
  ]),
  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.woodwide.ai/models/{model_id}/retrain"

	payload := strings.NewReader("{\n  \"dataset_id\": \"a1b2c3d4-0000-0000-0000-000000000001\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.woodwide.ai/models/{model_id}/retrain")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_id\": \"a1b2c3d4-0000-0000-0000-000000000001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.woodwide.ai/models/{model_id}/retrain")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset_id\": \"a1b2c3d4-0000-0000-0000-000000000001\"\n}"

response = http.request(request)
puts response.read_body

202

{
  "model": {
    "id": "b2c3d4e5-0000-0000-0000-000000000001",
    "version_id": "b2c3d4e5-0000-0000-0000-000000000002",
    "version_number": 1
  },
  "job_id": "b2c3d4e5-0000-0000-0000-000000000003",
  "status": "queued",
  "woodwide_runtime_version": "0.1"
}

{
  "detail": "Not authenticated"
}

{
  "detail": "Forbidden"
}

{
  "detail": "Not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Rate limit exceeded. Retry after a short delay."
}

Reuses the same model configuration (type, label column, input columns) from the previous version. Provide exactly one of dataset_version_id or dataset_id.

Returns a job_id for polling.

Authorizations

Authorization · string · header · required

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

Path Parameters

model_id · string<uuid> · required

Body

application/json

Request to retrain an existing model with new data.

Provide exactly one of dataset_id or dataset_version_id. The model configuration (type, label column, etc.) is inherited from the previous version.

dataset_version_id · string<uuid>

Pin a specific dataset version for retraining.

dataset_id · string<uuid>

Dataset to retrain on (uses latest ready version).

Response

202

application/json

Successful Response

Response for training a model.

model · ModelVersionRef · object · required

Model version reference.

Show child attributes

job_id · string<uuid> · required

status · string · required

woodwide_runtime_version · string · required