Get Training
Retrieve detailed information about a specific training job.
Endpoint
GET https://api.platform.knowledgator.com/trainings/{training_id}/
Headers
| Name | Type | Description |
|---|---|---|
KnowledgatorAPI-Key | String | Your API key |
Content-Type | String | application/json |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
training_id | String | Yes | Unique training job identifier (2-64 chars, alphanumeric with hyphens) |
Response
{
"id": "78d379da228a4985ba19100f53245b79",
"model_id": "comprehend-it",
"dataset_id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "successful",
"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
}
Response Fields
id: Unique training job identifiermodel_id: Base model ID being traineddataset_id: Dataset ID used for trainingstatus: Training status (pending, running, successful, failed, stopped)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
Error Codes
| Status Code | Description |
|---|---|
| 200 | OK – Request successful. |
| 400 | Bad Request – Invalid input or training doesn't exist. |
| 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');
// Get training details
const training = await kg.finetuning.getTraining('78d379da228a4985ba19100f53245b79');
console.log(`Training: ${training.id}`);
console.log(`Status: ${training.status}`);
console.log(`Model: ${training.model_id}`);
console.log(`Dataset: ${training.dataset_id}`);
if (training.completed_at) {
console.log(`Completed at: ${training.completed_at}`);
}
if (training.error) {
console.error(`Error: ${training.error}`);
}
Python
from knowledgator import Knowledgator
kg = Knowledgator(api_key="YOUR_API_KEY")
# Get training details
training = kg.finetuning.get_training("78d379da228a4985ba19100f53245b79")
print(f"Training: {training.id}")
print(f"Status: {training.status}")
print(f"Model: {training.model_id}")
print(f"Dataset: {training.dataset_id}")
if training.completed_at:
print(f"Completed at: {training.completed_at}")
if training.error:
print(f"Error: {training.error}")
Expected SDK Output
Training: 78d379da228a4985ba19100f53245b79
Status: successful
Model: comprehend-it
Dataset: 6babd48a-2256-4466-b16b-9fd45ba59688
Completed at: 2024-01-15T11:45:00Z
Python
import requests
url = "https://api.platform.knowledgator.com/trainings/78d379da228a4985ba19100f53245b79/"
headers = {
"KnowledgatorAPI-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
cURL
curl -X GET "https://api.platform.knowledgator.com/trainings/78d379da228a4985ba19100f53245b79/" \
-H "KnowledgatorAPI-Key: YOUR_API_KEY"
Expected Response (cURL)
{
"id": "78d379da228a4985ba19100f53245b79",
"model_id": "comprehend-it",
"dataset_id": "6babd48a-2256-4466-b16b-9fd45ba59688",
"status": "successful",
"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
}
Additional Information
- Training IDs: Use the ID returned from start training or list operations
- Status Monitoring: Poll this endpoint to monitor training progress
- Use Cases:
- Check training job status and progress
- Retrieve hyperparameters used for a training run
- Investigate failed trainings by checking error messages