Skip to main content
POST
/
api
/
v3
/
alignment-project
/
create
Alignment Workflow
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>",
  "baseModel": "<string>",
  "document_ids": [
    "<string>"
  ],
  "workflow_id": "<string>",
  "benchmarkId": "<string>",
  "description": "<string>"
}
'
"<string>"

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Provider
string
default:fwai
​
X-PROVIDER-SYNTHGEN
string
default:azure-openai
​
X-PROVIDER-SYNTHGEN-MODEL
string

Body

application/json

Request schema for creating alignment with synthetic data generation

​
name
string
required

Name of the domain alignment project

​
baseModel
string
required

Base model identifier

​
document_ids
string[]
required

List of document IDs to generate synthetic training data from

​
workflow_id
string | null

This id is to orchastrate the entire flow

​
benchmarkId
string | null

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

​
description
string | null

Optional project description

Response

Successful Response

The response is of type string.