curl --request GET \
--url https://api.nugen.in/api/v3/alignment-projects/{id}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nugen.in/api/v3/alignment-projects/{id}/status"
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-projects/{id}/status', 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}/status",
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}/status"
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-projects/{id}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nugen.in/api/v3/alignment-projects/{id}/status")
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": "<string>",
"status": "PROCESSING",
"queue_position": 123,
"degraded": true,
"stage_failures": [
"<unknown>"
],
"stop_requested_at": "<string>",
"error": "<string>",
"early_deployable": false,
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get Alignment Project Status
The polled status of one alignment project.
Returns the state and its qualifiers only. Configuration, documents and metrics never change while a run executes, so they live on the detail route and are not re-sent on every poll.
curl --request GET \
--url https://api.nugen.in/api/v3/alignment-projects/{id}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nugen.in/api/v3/alignment-projects/{id}/status"
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-projects/{id}/status', 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}/status",
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}/status"
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-projects/{id}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nugen.in/api/v3/alignment-projects/{id}/status")
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": "<string>",
"status": "PROCESSING",
"queue_position": 123,
"degraded": true,
"stage_failures": [
"<unknown>"
],
"stop_requested_at": "<string>",
"error": "<string>",
"early_deployable": false,
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Returns the current status of an alignment project: state, queue position, stop and failure qualifiers. Poll this; fetch the full record once from GET /alignment-project/{id}.
The polled view of one run: state, its qualifiers, nothing that never changes mid run. Configuration and documents live on the detail route.
Unique identifier of the alignment project.
Lifecycle status of a long-running task.
QUEUED: accepted and waiting its turn on a bounded queuePROCESSING: training in progressREADY: training completed, ready for deploymentDEPLOYING: model being deployed for evaluationEVALUATING: evaluation in progressUNDEPLOYED: model being undeployed after evaluationEVALUATED: evaluation completed, model undeployedSTOPPED: training stopped by the user before completionFAILED: failed at any stage
QUEUED is derived for the client at read time and never stored, so a
task read back later reports PROCESSING once execution has started.
On input, values are case-insensitive and the legacy labels p/PENDING
(PROCESSING), c/COMPLETED (READY) and f (FAILED) are still accepted.
PROCESSING, READY, FAILED, DEPLOYING, EVALUATING, UNDEPLOYED, EVALUATED, STOPPED, QUEUED Place in the queue while status is QUEUED, 1 meaning next to start.
True when the run reached its end state but a stage failed on the way.
Stage failures on the way; each entry carries stage, status and failed_reason.
Set once a stop was requested; the run ends STOPPED.
Present when status is FAILED.
True once training has written a checkpoint, so POST /models/{model_id}/deployment?early=true will succeed. Only meaningful while status is still PROCESSING; false once training has finished, since a normal deploy applies then.
Last update timestamp.
Was this page helpful?