Skip to main content
POST
/
api
/
v3
/
alignment-project
/
create
Create Alignment
curl --request POST \
  --url https://api.nugen.in/api/v3/alignment-project/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Alignment Project",
  "base_model": "nugen-flash-instruct",
  "document_ids": [
    "doc-abc123",
    "doc-def456"
  ],
  "workflow_id": "workflow-abc123",
  "benchmark_id": "benchmark-xyz789",
  "description": "This project aims to align the model for better customer support performance."
}
'
{
  "id": "alignment-project-123",
  "status": "pending"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Name of the domain alignment project

Example:

"My Alignment Project"

base_model
string
required

Base model that alignment will be based on

Example:

"nugen-flash-instruct"

document_ids
string[]
required

List of document IDs to generate synthetic training data from

Example:
["doc-abc123", "doc-def456"]
workflow_id
string | null

This id is to orchestrate the entire flow

Example:

"workflow-abc123"

benchmark_id
string | null

Benchmark ID for evaluation (created via /benchmark/create or /benchmark/upload)

Example:

"benchmark-xyz789"

description
string | null

Optional project description

Example:

"This project aims to align the model for better customer support performance."

Response

Returns a unique identifier for the initiated domain alignment workflow along with the initial workflow status. This endpoint starts an asynchronous process to fine-tune a base model using provided documents and optional benchmark evaluation, allowing users to track progress and retrieve results once completed.

Response schema for alignment project creation endpoint

id
string
required

Created alignment project task identifier

Example:

"alignment-project-123"

status
string
default:pending

Initial alignment project status

Example:

"pending"