Get Benchmark List

curl --request GET \
  --url https://api.nugen.in/api/v3/benchmark/list \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/benchmark/list"

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/benchmark/list', 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/benchmark/list",
  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/benchmark/list"

	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/benchmark/list")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/benchmark/list")

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

{
  "benchmarks": [
    "benchmark-123",
    "benchmark-456"
  ]
}

Benchmark

Get Benchmark List

Retrieve all benchmarks for the user.

This endpoint returns a comprehensive list of all benchmarks created or uploaded by the user, including both generated and manually uploaded benchmarks.

Returns:

benchmarks: List of benchmark objects, each containing:
- id: Unique benchmark identifier
- benchmark_name: Generated name (format: Benchmark_{document_id})
- status: Benchmark status (PROCESSING, READY, UPLOADED)
- documents: List of document IDs used for this benchmark (array with one element for uploaded benchmarks, multiple elements for generated benchmarks)
- num_questions: Number of questions in the benchmark
- created_at: Timestamp when benchmark was created
- updated_at: Timestamp when benchmark was last updated

Example Request:

GET /api/v3/benchmark/list
Headers: {"Authorization": "Bearer <api_key>"}

Example Response:

{
  "benchmarks": [
    {
      "id": "task-abc123",
      "benchmark_name": "Benchmark_doc-123",
      "status": "READY",
      "documents": ["doc-123", "doc-456"],
      "num_questions": 10,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:32:45Z"
    },
    {
      "id": "benchmark-xyz789",
      "benchmark_name": "Benchmark_doc-789",
      "status": "uploaded",
      "documents": ["doc-789"],
      "num_questions": 15,
      "created_at": "2024-01-16T14:20:00Z",
      "updated_at": "2024-01-16T14:20:00Z"
    }
  ]
}

GET

api

benchmark

list

Get Benchmark List

curl --request GET \
  --url https://api.nugen.in/api/v3/benchmark/list \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nugen.in/api/v3/benchmark/list"

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/benchmark/list', 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/benchmark/list",
  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/benchmark/list"

	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/benchmark/list")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nugen.in/api/v3/benchmark/list")

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

{
  "benchmarks": [
    "benchmark-123",
    "benchmark-456"
  ]
}

Authorizations

Authorization

string

header

required

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

Response

200 - application/json

Returns a list of all benchmarks created or uploaded by the user, including both generated and manually uploaded benchmarks

benchmarks

BenchmarkList · object[]

required

List of benchmarks

Show child attributes

Example:

["benchmark-123", "benchmark-456"]

Get Benchmark Data Delete Benchmark

Alignment Project

Models

Agents

Documents

Benchmark

Evaluations

Inference

Get Benchmark List

Authorizations

Response