List Aligned Models
curl --request GET \
--url https://api.nugen.in/api/v3/models/aligned \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nugen.in/api/v3/models/aligned"
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/aligned', 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/aligned",
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/aligned"
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/aligned")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nugen.in/api/v3/models/aligned")
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{
"domain_aligned_models": [
{
"base_model_id": "qwen-v2p5-0p5b-instruct",
"base_model_name": "Qwen-v2p5-0p5b-instruct",
"created_at": "2024-01-15T10:30:00Z",
"deployment_status": "DEPLOYED",
"model_id": "model_01k4x9m2p7q3r9d1",
"model_name": "model_contract_risk"
},
{
"base_model_id": "llama-v3p3-70b-instruct",
"base_model_name": "Llama V3p3 70b Instruct",
"created_at": "2024-02-01T09:15:00Z",
"deployment_status": "UNDEPLOYED",
"model_id": "model_01k4x9m2p7q3r9d2",
"model_name": "model_clinical_coding"
}
]
}{
"detail": "Bad request"
}{
"detail": "No aligned models found"
}{
"detail": [
{
"loc": [
"header",
"Authorization"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}Models
List Aligned Models
Retrieve all domain-aligned models for the authenticated user.
This endpoint returns a lean list row per aligned model. Fetch GET /models/{model_id} for the full record: performance metrics, evaluation data, usage, downloadability and conversation settings.
Query Parameters:
status(optional): Filter bydeployment_status, the only status-like field this list carrieslimit(optional): Number of models to return (1-100, default: 10)offset(optional): Number of models to skip for pagination (default: 0)
Returns:
domain_aligned_models: List of aligned model objects, each containing:model_id: Unique model identifier (oralignment-{id}for un-deployed models)model_name: Model namebase_model_id: Base model used for alignmentbase_model_name: Display name of the base modeldeployment_status: Current deployment state (READY,DEPLOYING,DEPLOYED,UNDEPLOYING,FAILED).READYmeans the model exists and is not serving; deploy to use.created_at: Creation timestamp
Example Request:
GET /api/v3/models/aligned
Headers: {"Authorization": "Bearer <api_key>"}
Example Response:
{
"domain_aligned_models": [
{
"model_id": "model_01kmqm4nrn9fw6r",
"model_name": "customer_support_model",
"base_model_id": "qwen-v2p5-0p5b-instruct",
"base_model_name": "Qwen-v2p5-0p5b-instruct",
"deployment_status": "DEPLOYED",
"created_at": "2024-01-15T10:30:00Z"
}
]
}
Notes:
- Returns both deployed and undeployed aligned models
- Use
/models/baseto see available base models for alignment
GET
/
api
/
v3
/
models
/
aligned
List Aligned Models
curl --request GET \
--url https://api.nugen.in/api/v3/models/aligned \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nugen.in/api/v3/models/aligned"
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/aligned', 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/aligned",
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/aligned"
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/aligned")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nugen.in/api/v3/models/aligned")
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{
"domain_aligned_models": [
{
"base_model_id": "qwen-v2p5-0p5b-instruct",
"base_model_name": "Qwen-v2p5-0p5b-instruct",
"created_at": "2024-01-15T10:30:00Z",
"deployment_status": "DEPLOYED",
"model_id": "model_01k4x9m2p7q3r9d1",
"model_name": "model_contract_risk"
},
{
"base_model_id": "llama-v3p3-70b-instruct",
"base_model_name": "Llama V3p3 70b Instruct",
"created_at": "2024-02-01T09:15:00Z",
"deployment_status": "UNDEPLOYED",
"model_id": "model_01k4x9m2p7q3r9d2",
"model_name": "model_clinical_coding"
}
]
}{
"detail": "Bad request"
}{
"detail": "No aligned 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
Filter by deployment_status
Number of models to return
Required range:
1 <= x <= 100Number of models to skip
Required range:
x >= 0Response
Returns a list of all domain-aligned models created by the authenticated user.
One summary row per aligned model. Performance metrics and evaluation data are served by GET /models/{model_id}.
Show child attributes
Show child attributes
Was this page helpful?