Get Evaluation Status

curl --request GET \
  --url https://api.nugen.in/api/v3/evaluations/{evaluation_id}/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/evaluations/{evaluation_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/evaluations/{evaluation_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/evaluations/{evaluation_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/evaluations/{evaluation_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/evaluations/{evaluation_id}/status")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

{
  "evaluation_id": "eval-abc123",
  "status": "PROCESSING",
  "benchmark_id": "benchmark-abc123",
  "progress": "3/10 questions",
  "questions_completed": 3,
  "total_questions": 10,
  "avg_time_per_question": 15.5,
  "eta_seconds": 300,
  "start_time": "2024-02-24T10:00:00Z",
  "end_time": "2024-02-24T10:05:00Z"
}

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

Evaluations

Get Evaluation Status

Get the current status and progress of an evaluation.

This endpoint retrieves the status of a running or completed evaluation with detailed progress metrics. Use this to track progress and determine when results are ready.

Path Parameters:

evaluation_id: Unique evaluation identifier

Returns:

evaluation_id: The evaluation identifier
status: Current status (PROCESSING, READY, FAILED)
benchmark_id: The benchmark being used for evaluation
progress (optional): Progress string (e.g., "3/10 questions")
questions_completed (optional): Number of questions completed so far
total_questions (optional): Total number of questions in the benchmark
avg_time_per_question (optional): Average time per question in seconds
eta_seconds (optional): Estimated time remaining in seconds

Raises:

404: If evaluation not found or doesn’t belong to the authenticated user

Example Request:

GET /api/v3/evaluations/eval-xyz789/status
Headers: {"Authorization": "Bearer <api_key>"}

Example Response (Pending):

{
  "evaluation_id": "eval-xyz789",
  "status": "PROCESSING",
  "benchmark_id": "task-abc123",
  "progress": "0/10 questions",
  "questions_completed": 0,
  "total_questions": 10
}

Example Response (In Progress):

{
  "evaluation_id": "eval-xyz789",
  "status": "PROCESSING",
  "benchmark_id": "task-abc123",
  "progress": "5/10 questions",
  "questions_completed": 5,
  "total_questions": 10,
  "avg_time_per_question": 12.5,
  "eta_seconds": 62
}

Example Response (Completed):

{
  "evaluation_id": "eval-xyz789",
  "status": "READY",
  "benchmark_id": "task-abc123",
  "progress": "10/10 questions",
  "questions_completed": 10,
  "total_questions": 10,
  "avg_time_per_question": 11.8
}

Notes:

Poll this endpoint to track evaluation progress
Once status is READY, use /evaluations/{evaluation_id}/results to get full results
Status FAILED indicates an error occurred during evaluation

GET

api

evaluations

{evaluation_id}

status

Get Evaluation Status

curl --request GET \
  --url https://api.nugen.in/api/v3/evaluations/{evaluation_id}/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/evaluations/{evaluation_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/evaluations/{evaluation_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/evaluations/{evaluation_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/evaluations/{evaluation_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/evaluations/{evaluation_id}/status")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

{
  "evaluation_id": "eval-abc123",
  "status": "PROCESSING",
  "benchmark_id": "benchmark-abc123",
  "progress": "3/10 questions",
  "questions_completed": 3,
  "total_questions": 10,
  "avg_time_per_question": 15.5,
  "eta_seconds": 300,
  "start_time": "2024-02-24T10:00:00Z",
  "end_time": "2024-02-24T10:05:00Z"
}

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

evaluation_id

string

required

Response

Returns the current status and progress of an evaluation. This endpoint retrieves the status of a running or completed evaluation with detailed progress metrics, allowing users to track the evaluation process and determine when results are ready.

evaluation_id

string

required

Unique identifier for the evaluation

Example:

"eval-abc123"

status

string

required

Current status (PROCESSING, READY, FAILED)

Example:

"PROCESSING"

benchmark_id

string

required

Benchmark ID used

Example:

"benchmark-abc123"

progress

string | null

Progress string (e.g., '3/10 questions')

Example:

"3/10 questions"

questions_completed

integer | null

Number of questions completed

Example:

3

total_questions

integer | null

Total number of questions

Example:

10

avg_time_per_question

number | null

Average time per question in seconds

Example:

15.5

eta_seconds

integer | null

Estimated time remaining in seconds

Example:

300

start_time

string<date-time> | null

Timestamp when evaluation started

Example:

"2024-02-24T10:00:00Z"

end_time

string<date-time> | null

Timestamp when evaluation completed

Example:

"2024-02-24T10:05:00Z"

Create Evaluation Get Evaluation Results

Alignment Project

Models

Agents

Documents

Benchmark

Evaluations

Inference

Get Evaluation Status

Authorizations

Path Parameters

Response