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": "<string>",
  "base_model": "<string>",
  "document_ids": [
    "<string>"
  ],
  "workflow_id": "<string>",
  "benchmark_id": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "status": "pending"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request schema for creating alignment with synthetic data generation

​
name
string
required

Name of the domain alignment project

​
base_model
string
required

Base model that alignment will be based on

​
document_ids
string[]
required

List of document IDs to generate synthetic training data from

​
workflow_id
string | null

This id is to orchestrate the entire flow

​
benchmark_id
string | null

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

​
description
string | null

Optional project description

Response

Successful Response

Response schema for alignment project creation endpoint

​
id
string
required

Created alignment project task identifier

​
status
string
default:pending

Initial alignment project status