List Base Models
curl --request GET \
--url https://api.nugen.in/api/v3/models/base \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nugen.in/api/v3/models/base"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nugen.in/api/v3/models/base', 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.nugen.in/api/v3/models/base",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nugen.in/api/v3/models/base"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nugen.in/api/v3/models/base")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nugen.in/api/v3/models/base")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"models": [
{
"alignment_ready": true,
"available_on_request": false,
"model_id": "Qwen/Qwen2.5-0.5B-Instruct",
"model_name": "Qwen/Qwen2.5-0.5B-Instruct",
"parameters": "0.5B",
"type": "llm"
},
{
"access_request_status": "PENDING",
"alignment_ready": false,
"available_on_request": true,
"model_id": "Qwen/Qwen2.5-1.5B-Instruct",
"model_name": "Llama V3p3 70b Instruct",
"parameters": "70B",
"type": "llm"
}
]
}{
"detail": "Bad request"
}{
"detail": "No base models found"
}{
"detail": [
{
"loc": [
"header",
"Authorization"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}Models
List Base Models
Retrieve the list of available base models.
This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows.
Query Parameters:
alignment_ready(optional):trueorfalseinference_ready(optional):trueorfalsetype(optional):text-generationorimage-text-to-textlimit(optional): Number of models to return (1-100, default: 10)offset(optional): Number of models to skip for pagination (default: 0)
Returns:
models: List of base model objects, each containing:model_id: Unique model identifiermodel_name: Human-readable model nameparameters: Model parameter countalignment_ready: Whether model can be used as a base for domain alignmentinference_ready: Whether model is deployed for chat, completions, embeddings or rerankavailable_on_request: Whether this model requires an access request before usetype: Hugging Facepipeline_tag,text-generationorimage-text-to-text. Embedding and reranking base models are not listed; use an aligned model id for bothmodel_card: URL of the model card README on Hugging Face
Example Request:
GET /api/v3/models/base
Headers: {"Authorization": "Bearer <api_key>"}
Example Response:
{
"models": [
{
"model_id": "Qwen/Qwen2.5-0.5B-Instruct",
"model_name": "Qwen/Qwen2.5-0.5B-Instruct",
"parameters": "0.49B",
"alignment_ready": true,
"inference_ready": true,
"available_on_request": false,
"type": "text-generation",
"model_card": "https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md"
},
{
"model_id": "nomic-ai/nomic-embed-text-v1.5",
"model_name": "nomic-ai/nomic-embed-text-v1.5",
"parameters": "0.14B",
"alignment_ready": false,
"inference_ready": true,
"available_on_request": false,
"type": "embedding",
"model_card": "https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md"
}
]
}
Notes:
- Base models are general-purpose starting points for domain alignment
- These models can be used directly or as base models for domain alignment
- Use
/models/alignedto see your custom domain-aligned models alignment_readyindicates if the model can be used as a base for domain alignment
GET
/
api
/
v3
/
models
/
base
List Base Models
curl --request GET \
--url https://api.nugen.in/api/v3/models/base \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nugen.in/api/v3/models/base"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nugen.in/api/v3/models/base', 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.nugen.in/api/v3/models/base",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nugen.in/api/v3/models/base"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nugen.in/api/v3/models/base")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nugen.in/api/v3/models/base")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"models": [
{
"alignment_ready": true,
"available_on_request": false,
"model_id": "Qwen/Qwen2.5-0.5B-Instruct",
"model_name": "Qwen/Qwen2.5-0.5B-Instruct",
"parameters": "0.5B",
"type": "llm"
},
{
"access_request_status": "PENDING",
"alignment_ready": false,
"available_on_request": true,
"model_id": "Qwen/Qwen2.5-1.5B-Instruct",
"model_name": "Llama V3p3 70b Instruct",
"parameters": "70B",
"type": "llm"
}
]
}{
"detail": "Bad request"
}{
"detail": "No base models found"
}{
"detail": [
{
"loc": [
"header",
"Authorization"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Only models that can, or cannot, be aligned
Only models that are, or are not, deployed for inference
Only models whose type matches exactly, e.g. text-generation or embedding
Number of models to return
Required range:
1 <= x <= 100Number of models to skip
Required range:
x >= 0Response
Returns a list of all available base models that can be used for domain alignment.
List of available base models
Show child attributes
Show child attributes
Was this page helpful?