Skip to main content

Get Model

Retrieve detailed information about a specific model.

Endpoint​

GET https://api.platform.knowledgator.com/models/{model_id}/

Public Endpoint: This catalog endpoint is publicly accessible and does not require authentication. Do not pass KnowledgatorAPI-Key or Authorization: Bearer headers (sending auth headers causes 401 Unauthorized: auth.invalid_token).

Base Models vs. Your Custom Models

GET /models/{model_id}/ retrieves information about a public base model or open model from the catalog. To retrieve details and status for your own custom fine-tuned model, see Get Training (GET /trainings/{training_id}/).


Headers​

NameTypeRequiredDescription
Content-TypeStringNoapplication/json

Path Parameters​

ParameterTypeRequiredDescription
model_idStringYesUnique model identifier (2-64 chars, alphanumeric with hyphens)

Response​

{
"id": "comprehend-it",
"name": "comprehend-it",
"type": "text-classification",
"description": "Zero-shot text classification and reasoning model",
"num_of_parameters": "494M",
"training_model": true,
"training_adapter": true,
"inference": "comprehend-it",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"is_base": true
}

Response Fields​

  • id: Unique model identifier
  • name: Model name
  • type: Service type (ner, text-classification, etc.)
  • num_of_parameters: Number of parameters (e.g. "494M", "1.1B", or numeric)
  • training_model: Boolean indicating if full model training is supported
  • training_adapter: Boolean indicating if LoRA adapter training is supported
  • inference: Inference service compatibility
  • fine_tuned: Boolean indicating if this is a fine-tuned model/adapter
  • parent_model: Parent base model ID if fine-tuned
  • description: Full markdown model description
  • short_description: Brief summary description
  • created_at: ISO 8601 timestamp of creation
  • updated_at: ISO 8601 timestamp of last update
  • is_base: Whether this is a base model (not trained by customer)

Error Codes​

Status CodeDescription
200OK – Request successful.
400Bad Request – Invalid input or model doesn't exist.
401Unauthorized – Invalid API key or email verification required.
500Internal Server Error – Server-side issue.
503Service 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(); // API key optional for public catalog

// Get model details
const model = await kg.finetuning.getModel('comprehend-it');
console.log(`Model: ${model.name}`);
console.log(`Parameters: ${model.num_of_parameters}`);
console.log(`Trainable Adapter: ${model.training_adapter}`);

Python​

from knowledgator import Knowledgator

kg = Knowledgator() # API key optional for public catalog

# Get model details
model = kg.finetuning.get_model("comprehend-it")
print(f"Model: {model.name}")
print(f"Parameters: {model.num_of_parameters}")
print(f"Trainable Adapter: {model.training_adapter}")

Expected SDK Output​

Model: comprehend-it
Parameters: 494M
Trainable Adapter: true

Python​

import requests

url = "https://api.platform.knowledgator.com/models/comprehend-it/"

response = requests.get(url)
print(response.json())

cURL​

# Public endpoint - no API key needed
curl -X GET "https://api.platform.knowledgator.com/models/comprehend-it/"

Expected Response (cURL)​

{
"id": "comprehend-it",
"name": "comprehend-it",
"type": "text-classification",
"description": "Zero-shot text classification and reasoning model",
"num_of_parameters": "494M",
"training_model": true,
"training_adapter": true,
"inference": "comprehend-it",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"is_base": true
}

Additional Information​

  • Model IDs: Use the ID returned from create or list operations
  • Use Cases:
    • Verify model details before starting training
    • Check model metadata and configuration
    • Confirm model type matches your dataset