Benchmarks
List Benchmarks
Retrieve all benchmarks for the user.
This endpoint returns a paginated list of all benchmarks created or uploaded by the user, including both generated and manually uploaded benchmarks.
Query Parameters:
- status (optional): Filter by benchmark status
- limit (optional): Number of benchmarks to return (1-100, default: 10)
- offset (optional): Number of benchmarks to skip for pagination (default: 0)
Returns:
- benchmarks: List of benchmark objects, each containing:
- benchmark_id: Unique benchmark identifier
- benchmark_name: Display name of the benchmark
- status: Benchmark status (PROCESSING, READY, UPLOADED)
- created_at: Timestamp when benchmark was created
Example Request:
GET /api/v3/benchmarks/list
Headers: {"Authorization": "Bearer <api_key>"}
Example Response:
{
"benchmarks": [
{
"benchmark_id": "benchmark_01k4x9m2p7q3r6a1",
"benchmark_name": "Benchmark_document_01k4x9m2p7q3r5se",
"status": "READY",
"created_at": "2024-01-15T10:30:00Z"
},
{
"benchmark_id": "benchmark_01k4x9m2p7q3r6a2",
"benchmark_name": "Benchmark_document_01k4x9m2p7q3r5sg",
"status": "uploaded",
"created_at": "2024-01-16T14:20:00Z"
}
]
}
get/api/v3/benchmarks/list
Request
- Base URLhttps://api.nugen.in
- AuthHTTP bearer
Query parameters
statusstring nullable
Filter by benchmark status
limitinteger
Number of benchmarks to return
offsetinteger
Number of benchmarks to skip
Response
Returns a list of all benchmarks created or uploaded by the user, including both generated and manually uploaded benchmarks
Example response
{
"benchmarks": [
"benchmark_01k4x9m2p7q3r6a1",
"benchmark_01k4x9m2p7q3r6a2"
]
}Changes
No recorded changes to this operation across all 1 revision of this API.