Get Alignment Data

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

import requests

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

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/{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-project/{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-project/{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))

}

HttpResponse<String> response = Unirest.get("https://api.nugen.in/api/v3/alignment-project/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/alignment-project/{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

{
  "alignment_id": "alignment-abc123",
  "alignment_name": "Customer Support Model",
  "base_model": "nugen-flash-instruct",
  "completed_date": "2024-01-15T12:45:00Z",
  "created_date": "2024-01-15T10:30:00Z",
  "creator": "user@example.com",
  "document_count": 3,
  "document_ids": [
    "doc-abc123",
    "doc-def456",
    "doc-ghi789"
  ],
  "evaluation_id": "eval-xyz789",
  "model_id": "alignment-abc123-deployed",
  "performance_metrics": {
    "accuracy_after": 0.92,
    "accuracy_before": 0.75,
    "domain_violations_after": 2,
    "domain_violations_before": 12,
    "uncertainty_after": 0.15,
    "uncertainty_before": 0.35
  },
  "progress": 100,
  "status": "READY"
}

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

Alignment Project

Get Alignment Data

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:

id: Alignment project identifier
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
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

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

{
  "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,
    "perplexity": 2.3
  },
  "evaluation_id": "eval-def456",
  "model_id": "alignment-xyz789-deployed"
}

Example Response (In Progress):

{
  "id": "alignment-abc456",
  "name": "Technical Documentation Alignment",
  "base_model": "nugen-flash-instruct",
  "status": "PROCESSING",
  "created_date": "2024-01-16T09:00:00Z",
  "documents": ["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-project

{id}

Get Alignment Data

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

import requests

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

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/{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-project/{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-project/{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))

}

HttpResponse<String> response = Unirest.get("https://api.nugen.in/api/v3/alignment-project/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/alignment-project/{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

{
  "alignment_id": "alignment-abc123",
  "alignment_name": "Customer Support Model",
  "base_model": "nugen-flash-instruct",
  "completed_date": "2024-01-15T12:45:00Z",
  "created_date": "2024-01-15T10:30:00Z",
  "creator": "user@example.com",
  "document_count": 3,
  "document_ids": [
    "doc-abc123",
    "doc-def456",
    "doc-ghi789"
  ],
  "evaluation_id": "eval-xyz789",
  "model_id": "alignment-abc123-deployed",
  "performance_metrics": {
    "accuracy_after": 0.92,
    "accuracy_before": 0.75,
    "domain_violations_after": 2,
    "domain_violations_before": 12,
    "uncertainty_after": 0.15,
    "uncertainty_before": 0.35
  },
  "progress": 100,
  "status": "READY"
}

{
  "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

Returns detailed information about a specific alignment project, including metadata, associated documents, training progress, status, performance metrics, and evaluation information

alignment_id

string

required

Unique identifier for the alignment project

Example:

["alignment-abc123", "alignment-xyz789"]

alignment_name

string

required

Human-readable name for the alignment project

Example:

[
  "Customer Support Model",
  "Legal Document Assistant",
  "Medical Q&A Bot"
]

base_model

string

required

ID of the base model used for alignment training

Example:

["nugen-flash-instruct", "model-20240229"]

status

enum<string>

required

Current status of the alignment project (PROCESSING, READY, FAILED)

Available options:

PROCESSING,

READY,

FAILED,

DEPLOYING,

EVALUATING,

UNDEPLOYED,

EVALUATED,

STOPPED

created_date

string

required

ISO 8601 timestamp when the project was created

Example:

[
  "2024-01-15T10:30:00Z",
  "2024-02-01T09:15:00Z"
]

document_ids

string[]

required

List of document IDs used for alignment training

Example:

[
  ["doc-abc123", "doc-def456"],
  ["doc-xyz789"]
]

document_count

integer

required

Total number of documents used for training

Required range: x >= 0

Example:

[5, 12, 3]

creator

string

required

Email/username of the user who created this project

Example:

["user@example.com", "admin@company.com"]

completed_date

string | null

ISO 8601 timestamp when the project completed (null if still in progress or failed)

Example:

["2024-01-15T12:45:00Z", null]

performance_metrics

AlignmentProjectPerformanceMetrics · object | null

Performance comparison metrics showing before/after alignment improvements (available after evaluation)

Show child attributes

progress

integer | null

Training progress percentage (0-100). Null if not started or completed.

Required range: 0 <= x <= 100

Example:

[0, 45, 100, null]

estimated_completion

string | null

Estimated completion time (ISO 8601 timestamp). Null if not available or completed.

Example:

["2024-01-15T14:00:00Z", null]

error

string | null

Error message if the alignment project failed. Null if no error.

Example:

[
  "Training failed: insufficient data",
  "Out of memory error",
  null
]

evaluation_id

string | null

Auto-evaluation ID if automatic evaluation was triggered after alignment completion

Example:

["eval-abc123", null]

model_id

string | null

Deployed model ID if the aligned model was automatically deployed for evaluation

Example:

["alignment-abc123-deployed", null]

gpu_training_completed

boolean | null

Whether GPU training completed successfully. True if completed, False if failed/cancelled, null if still in progress.

Example:

[true, false, null]

Get Alignment Status Delete Alignment

Alignment Project

Models

Agents

Documents

Benchmark

Evaluations

Inference

Get Alignment Data

Authorizations

Path Parameters

Response