Start a family
Start a new family with its first fine-tune, from a base or one of your models
(from), on a dataset version, its newest unless you name one. Its model joins the family
as family@1 if it passes its gate. To train an existing family on new rows, continue it
(POST /v1/families/{family}/continue). While a large dataset version’s training tokens
are first counted, it answers 503 tokens_counting with Retry-After and starts nothing.
curl --request POST \
--url https://api.sqwish.ai/v1/families \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dataset_id": "<string>",
"family": "<string>",
"from": "kettei-core",
"method": "sft",
"hyperparameters": {
"steps": 2,
"learning_rate": 0.00005,
"lora_rank": 8,
"seed": 42
},
"dataset_version": 2,
"max_price_usd": "<string>"
}
'import requests
url = "https://api.sqwish.ai/v1/families"
payload = {
"dataset_id": "<string>",
"family": "<string>",
"from": "kettei-core",
"method": "sft",
"hyperparameters": {
"steps": 2,
"learning_rate": 0.00005,
"lora_rank": 8,
"seed": 42
},
"dataset_version": 2,
"max_price_usd": "<string>"
}
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: '<string>',
family: '<string>',
from: 'kettei-core',
method: 'sft',
hyperparameters: {steps: 2, learning_rate: 0.00005, lora_rank: 8, seed: 42},
dataset_version: 2,
max_price_usd: '<string>'
})
};
fetch('https://api.sqwish.ai/v1/families', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"dataset_id": "<string>",
"model": "<string>",
"method": "sft",
"hyperparameters": {
"steps": 123,
"learning_rate": 123,
"lora_rank": 123,
"seed": 123
},
"family": "<string>",
"family_deleted": true,
"parent": "<string>",
"dataset_version": 123,
"status": "queued",
"outcome": "joined",
"created_at": 123,
"updated_at": 123,
"output_model": "<string>",
"metrics": {},
"error": "<string>",
"progress": {},
"limits": {},
"split": {},
"lineage": {},
"price_usd": "<string>",
"charge": "free",
"dataset_evaluation": {
"id": "<string>",
"dataset_id": "<string>",
"dataset_version": 123,
"model_id": "<string>",
"model_sha256": "<string>",
"model_label": "<string>",
"model_name": "<string>",
"version": 123,
"status": "queued",
"created_at": 123,
"updated_at": 123,
"generation": 123,
"training_job_id": "<string>",
"dataset_sha256": "<string>",
"evaluation_sha256": "<string>",
"method": "sft",
"evaluation_rows": 123,
"decisions": 123,
"completed_rows": 123,
"metrics": {},
"error": {},
"named": "<string>"
},
"curve": [
{
"step": 123,
"loss": 123,
"learning_rate": 123
}
],
"rows_deleted": true
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}Authorizations
Create an API key in the console.
Headers
Reuse the same key and body after a lost response. A replay returns the job that key queued, with Idempotency-Replayed: true. A changed body conflicts.
Body
A new family's first fine-tune, from a base or one of your models.
^ds_[a-f0-9]{24}$The new family's name: lowercase letters and digits, with single hyphens between them, 2 to 63 characters. A name already taken is refused with family_exists.
63^[a-z](?:-?[a-z0-9]){1,62}$Where the family starts: a base model that can be fine-tuned, or one of your models as family@N, which it trains from on that model's base. Left out, core.
1 - 140sft, reward Show child attributes
Show child attributes
The version of the dataset to train on, its newest when left out. The family trains on every training row of that version, and continues from it.
x >= 1The most you agree to pay for this job, in USD, such as the price you were shown. It is a decimal string, such as "2.500000000", never a JSON number, so no precision is lost: a number is refused with invalid_request, naming this field. If it costs more when it is admitted, it is refused with price_changed and nothing is held.
^\d{1,9}(\.\d{1,9})?$Response
Successful Response
sft, reward What a job trains with, as its owner chose or the defaults gave it. The trainer's own settings stay on the server.
Show child attributes
Show child attributes
The family the job adds a model to.
True once you deleted that family. The job and its charge stay.
The id of the model it trains from, or null from a base.
The version of its dataset it trains on.
queued, running, cancelling, succeeded, failed, cancelled How it ended for its family: its model joined the family with the next number, or failed its gate and is not kept for you, or the run failed or was cancelled, or a rollback discarded the model that joined. Only a failed run or a cancellation is free and leaves the data for another try. Null while it runs.
joined, gate_failed, failed, cancelled, rolled_back Evaluation groups and the gate, when complete.
max_questions: the most decisions a row of it may ask.
Show child attributes
Show child attributes
train_rows and validation_rows, and trained_tokens: the training tokens the job trains, each decision of a row with the row's whole text, tokenized as input tokens are (an outcome at least 8, a row of n decisions at least 24 × n for each), each time a step takes the row. A priced fine-tune's fee is fine_tune_million_tokens_usd for them, at least fine_tune_minimum_usd.
Show child attributes
Show child attributes
The fee held for this job, as exact USD.
What the fee is doing: held while the job runs, charged if it succeeds, released if it fails or is cancelled.
free, reserved, charged, released Show child attributes
Show child attributes
The training loss over steps, at most 300 points, each the means of a run of consecutive steps. Null until the job succeeds, or when its trainer kept none. Lists of jobs leave it out.
Show child attributes
Show child attributes
True once a dataset whose rows its specification held was deleted: the job, its model and its metrics stay, but its held-out records are gone.
curl --request POST \
--url https://api.sqwish.ai/v1/families \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dataset_id": "<string>",
"family": "<string>",
"from": "kettei-core",
"method": "sft",
"hyperparameters": {
"steps": 2,
"learning_rate": 0.00005,
"lora_rank": 8,
"seed": 42
},
"dataset_version": 2,
"max_price_usd": "<string>"
}
'import requests
url = "https://api.sqwish.ai/v1/families"
payload = {
"dataset_id": "<string>",
"family": "<string>",
"from": "kettei-core",
"method": "sft",
"hyperparameters": {
"steps": 2,
"learning_rate": 0.00005,
"lora_rank": 8,
"seed": 42
},
"dataset_version": 2,
"max_price_usd": "<string>"
}
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: '<string>',
family: '<string>',
from: 'kettei-core',
method: 'sft',
hyperparameters: {steps: 2, learning_rate: 0.00005, lora_rank: 8, seed: 42},
dataset_version: 2,
max_price_usd: '<string>'
})
};
fetch('https://api.sqwish.ai/v1/families', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"dataset_id": "<string>",
"model": "<string>",
"method": "sft",
"hyperparameters": {
"steps": 123,
"learning_rate": 123,
"lora_rank": 123,
"seed": 123
},
"family": "<string>",
"family_deleted": true,
"parent": "<string>",
"dataset_version": 123,
"status": "queued",
"outcome": "joined",
"created_at": 123,
"updated_at": 123,
"output_model": "<string>",
"metrics": {},
"error": "<string>",
"progress": {},
"limits": {},
"split": {},
"lineage": {},
"price_usd": "<string>",
"charge": "free",
"dataset_evaluation": {
"id": "<string>",
"dataset_id": "<string>",
"dataset_version": 123,
"model_id": "<string>",
"model_sha256": "<string>",
"model_label": "<string>",
"model_name": "<string>",
"version": 123,
"status": "queued",
"created_at": 123,
"updated_at": 123,
"generation": 123,
"training_job_id": "<string>",
"dataset_sha256": "<string>",
"evaluation_sha256": "<string>",
"method": "sft",
"evaluation_rows": 123,
"decisions": 123,
"completed_rows": 123,
"metrics": {},
"error": {},
"named": "<string>"
},
"curve": [
{
"step": 123,
"loss": 123,
"learning_rate": 123
}
],
"rows_deleted": true
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}