List Alignment Projects

curl --request GET \
  --url https://api.nugen.in/api/v3/alignment-project \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/alignment-project"

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/alignment-project', 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/alignment-project",
  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/alignment-project"

	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/alignment-project")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/alignment-project")

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

{
  "alignment_projects": [
    {
      "base_model": "nugen-flash-instruct",
      "completed_date": "2024-01-15T12:45:00Z",
      "created_date": "2024-01-15T10:30:00Z",
      "creator": "user-xyz123",
      "document_count": 3,
      "documents": [
        "doc-abc123",
        "doc-def456",
        "doc-ghi789"
      ],
      "id": "alignment-abc123",
      "name": "Customer Support Model",
      "status": "READY"
    }
  ]
}

Alignment Project

List Alignment Projects

Retrieve all alignment projects for the authenticated user.

This endpoint returns a comprehensive list of all domain alignment projects created by the user, including project metadata, status, training progress, associated documents, and evaluation results.

Returns:

alignment_projects: List of alignment project objects, each containing:
- id: Unique alignment project identifier
- name: Project name
- base_model: Base model identifier used for alignment
- status: Project status (PROCESSING, READY)
- created_date: ISO timestamp when project was created
- completed_date (optional): ISO timestamp when project completed
- documents: List of document IDs used for training
- document_count: Number of documents used
- creator: Username or ID of the project creator
- performance_metrics (optional): Training performance metrics (loss, accuracy, etc.)
- progress (optional): Training progress percentage (0-100)
- estimated_completion (optional): Estimated completion time
- error (optional): Error message if project failed
- evaluation_id (optional): Auto-evaluation ID if triggered
- model_id (optional): Deployed model ID for evaluation

Example Request:

GET /api/v3/alignment
Headers: {"Authorization": "Bearer <api_key>"}

Example Response:

{
  "alignment_projects": [
    {
      "id": "alignment-xyz789",
      "name": "Customer Support Domain Alignment",
      "base_model": "nugen-flash-instruct",
      "status": "READY",
      "created_date": "2024-01-15T10:30:00Z",
      "completed_date": "2024-01-15T14:45:00Z",
      "documents": ["doc-abc123", "doc-xyz456", "doc-def789"],
      "document_count": 3,
      "creator": "user-123",
      "performance_metrics": {
        "final_loss": 0.15,
        "accuracy": 0.92
      },
      "evaluation_id": "eval-def456",
      "model_id": "alignment-xyz789-deployed"
    }
  ]
}

Notes:

Returns all alignment projects regardless of status
model_id is only available for projects that have been deployed for evaluation
evaluation_id is only present if auto-evaluation was triggered
performance_metrics are populated after training completes
progress and estimated_completion are available during training

GET

api

alignment-project

List Alignment Projects

curl --request GET \
  --url https://api.nugen.in/api/v3/alignment-project \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/alignment-project"

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/alignment-project', 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/alignment-project",
  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/alignment-project"

	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/alignment-project")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/alignment-project")

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

{
  "alignment_projects": [
    {
      "base_model": "nugen-flash-instruct",
      "completed_date": "2024-01-15T12:45:00Z",
      "created_date": "2024-01-15T10:30:00Z",
      "creator": "user-xyz123",
      "document_count": 3,
      "documents": [
        "doc-abc123",
        "doc-def456",
        "doc-ghi789"
      ],
      "id": "alignment-abc123",
      "name": "Customer Support Model",
      "status": "READY"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Returns a list of all alignment projects for the authenticated user, including project metadata, status, training progress, associated documents, and evaluation results

alignment_projects

AlignmentProject · object[]

required

List of alignment projects

Show child attributes

Example:

[
  {
    "base_model": "nugen-flash-instruct",
    "completed_date": "2024-01-15T12:45:00Z",
    "created_date": "2024-01-15T10:30:00Z",
    "creator": "user-xyz123",
    "document_count": 3,
    "documents": ["doc-abc123", "doc-def456", "doc-ghi789"],
    "id": "alignment-abc123",
    "name": "Customer Support Model",
    "status": "READY"
  }
]

Delete Alignment Stop Alignment

Alignment Project

Models

Agents

Documents

Benchmark

Evaluations

Inference

List Alignment Projects

Authorizations

Response