List Trainings
Retrieve a paginated list of your custom fine-tuned models and training jobs with optional filtering by status and type.
Your Custom Models Library
GET /trainings/ lists all models you have created through fine-tuning. To view public base models and open model architectures, see List Models (GET /models/).
Endpoint
GET https://api.platform.knowledgator.com/trainings/
Headers
| Name | Type | Description |
|---|---|---|
KnowledgatorAPI-Key | String | Your API key |
Content-Type | String | application/json |
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
offset | Integer | No | Pagination offset (default: 0, min: 0) |
limit | Integer | No | Maximum results per page (default: 100, max: 10000) |
status | String | No | Filter by status: active, completed, stopped, failed |
type | String | No | Filter by service type: ner, text-classification, relation-extraction |
Response
{
"trainings": [
{
"id": "78d379da228a4985ba19100f53245b79",
"model_id": "comprehend-it",
"dataset_id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "completed",
"hyperparameters": {
"learning_rate": 0.001,
"batch_size": 32
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T11:45:00Z",
"started_at": "2024-01-15T10:31:00Z",
"completed_at": "2024-01-15T11:45:00Z",
"error": null
}
],
"total": 1,
"offset": 0,
"limit": 100
}
Response Fields
trainings: Array of training job objectsid: Unique training job identifiermodel_id: Base model ID being traineddataset_id: Dataset ID used for trainingstatus: Training status (active,completed,stopped,failed)hyperparameters: Training hyperparameters usedcreated_at: ISO 8601 timestamp of creationupdated_at: ISO 8601 timestamp of last updatestarted_at: ISO 8601 timestamp when training startedcompleted_at: ISO 8601 timestamp when training completederror: Error message if training failed
total: Total number of training jobs matching the filteroffset: Current pagination offsetlimit: Current pagination limit
Error Codes
| Status Code | Description |
|---|---|
| 200 | OK – Request successful. |
| 400 | Bad Request – Invalid input or validation failed. |
| 401 | Unauthorized – Invalid API key or email verification required. |
| 500 | Internal Server Error – Server-side issue. |
| 503 | Service Unavailable – Service temporarily unavailable. |
Example Usage
SDK Usage
💡 Dedicated SDK Guides: See Python SDK | TypeScript SDK
TypeScript/JavaScript
import { createClient } from '@knowledgator/typescript-sdk';
const kg = createClient('YOUR_API_KEY');
// List all training jobs
const result = await kg.finetuning.listTrainings();
console.log(result.trainings);
// List successful trainings only
const successful = await kg.finetuning.listTrainings({
status: 'completed',
limit: 50
});
console.log(successful.trainings);
// List NER training jobs
const nerTrainings = await kg.finetuning.listTrainings({
type: 'ner'
});
console.log(nerTrainings.trainings);
Python
from knowledgator import Knowledgator
kg = Knowledgator(api_key="YOUR_API_KEY")
# List all training jobs
result = kg.finetuning.list_trainings()
print(result.trainings)
# List successful trainings only
successful = kg.finetuning.list_trainings(
status="completed",
limit=50
)
print(successful.trainings)
# List NER training jobs
ner_trainings = kg.finetuning.list_trainings(
type="ner"
)
print(ner_trainings.trainings)
Expected SDK Output
[
{
"id": "78d379da228a4985ba19100f53245b79",
"model_id": "comprehend-it",
"dataset_id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "completed",
"hyperparameters": {
"learning_rate": 0.001,
"batch_size": 32
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T11:45:00Z",
"started_at": "2024-01-15T10:31:00Z",
"completed_at": "2024-01-15T11:45:00Z",
"error": null
}
]
Python
import requests
url = "https://api.platform.knowledgator.com/trainings/"
headers = {
"KnowledgatorAPI-Key": "YOUR_API_KEY"
}
# List all training jobs
response = requests.get(url, headers=headers)
print(response.json())
# List successful trainings only
params = {
"status": "completed",
"limit": 50
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
cURL
# List all training jobs
curl -X GET "https://api.platform.knowledgator.com/trainings/" \
-H "KnowledgatorAPI-Key: YOUR_API_KEY"
# List successful trainings only
curl -X GET "https://api.platform.knowledgator.com/trainings/?status=completed&limit=50" \
-H "KnowledgatorAPI-Key: YOUR_API_KEY"
Expected Response (cURL)
{
"trainings": [
{
"id": "78d379da228a4985ba19100f53245b79",
"model_id": "comprehend-it",
"dataset_id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "completed",
"hyperparameters": {
"learning_rate": 0.001,
"batch_size": 32
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T11:45:00Z",
"started_at": "2024-01-15T10:31:00Z",
"completed_at": "2024-01-15T11:45:00Z",
"error": null
}
],
"total": 1,
"offset": 0,
"limit": 50
}
Additional Information
- Pagination: Use
offsetandlimitparameters to paginate through large result sets - Filtering: Combine status and type filters to narrow down results
- Use Cases:
- Monitor training job progress
- Find successful trainings for deployment
- Identify failed trainings for debugging