Get Alignment Project

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nugen.in/api/v3/alignment-projects/{id}', 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-projects/{id}",
  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-projects/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/alignment-projects/{id}")

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

General

Get Alignment Project

Retrieve detailed information about a specific alignment project.

This endpoint fetches comprehensive details about an alignment project including metadata, associated documents, training progress, status, performance metrics, and evaluation information.

Path Parameters:

id: Unique identifier of the alignment project

Returns:

alignment_id: Alignment project identifier
alignment_name: Project name
base_model: Base model identifier used for alignment
status: Project status (PENDING, COMPLETED, FAILED)
created_date: ISO timestamp when project was created
completed_date (optional): ISO timestamp when project completed
document_ids: 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

Raises:

404: If alignment project not found or doesn’t belong to user

Example Request:

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

Example Response (Completed):

{
  "alignment_id":"alignment-xyz789",
  "alignment_name": "Customer Support Domain Alignment",
  "base_model": "qwen-v2p5-0p5b-instruct",
  "status": "READY",
  "created_date": "2024-01-15T10:30:00Z",
  "completed_date": "2024-01-15T14:45:00Z",
  "document_ids": ["doc-abc123", "doc-xyz456", "doc-def789"],
  "document_count": 3,
  "creator": "user-123",
  "performance_metrics": {
    "final_loss": 0.15,
    "accuracy": 0.92,
    "perplexity": 2.3
  },
  "evaluation_id": "eval-def456",
  "model_id": "alignment-xyz789-deployed"
}

Example Response (In Progress):

{
  "alignment_id":"alignment-abc456",
  "alignment_name": "Technical Documentation Alignment",
  "base_model": "qwen-v2p5-0p5b-instruct",
  "status": "PROCESSING",
  "created_date": "2024-01-16T09:00:00Z",
  "document_ids": ["doc-111", "doc-222"],
  "document_count": 2,
  "creator": "user-123",
  "progress": 45,
  "estimated_completion": "2024-01-16T11:30:00Z"
}

Notes:

Returns full project details including training progress and performance
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
error field contains failure details if status is FAILED

GET

api

alignment-projects

{id}

Get Alignment Project

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nugen.in/api/v3/alignment-projects/{id}', 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-projects/{id}",
  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-projects/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/alignment-projects/{id}")

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Response

Successful Response

Models

Documents

Benchmark

Evaluations

Inference

General

Get Alignment Project

Authorizations

Path Parameters

Response